Skip to content

docs: add sync-state troubleshooting guide to README#1050

Open
mehmetkr-31 wants to merge 1 commit intobase:mainfrom
mehmetkr-31:docs/troubleshooting-sync-state
Open

docs: add sync-state troubleshooting guide to README#1050
mehmetkr-31 wants to merge 1 commit intobase:mainfrom
mehmetkr-31:docs/troubleshooting-sync-state

Conversation

@mehmetkr-31
Copy link
Copy Markdown

Summary

Expands the Troubleshooting section from a single Discord link into a practical guide for the three most common operator issues.

Problem

  • Issue AwaitingELSyncCompletion #1041 and Discord #🛠|node-operators show that new operators repeatedly mistake AwaitingELSyncCompletion for a fatal error.
  • There is no in-repo documentation explaining what this log means or how long to wait.
  • Connection issues between EL and CL are also frequently reported without a local checklist.

Solution

Add three subsections under Troubleshooting:

  1. AwaitingELSyncCompletion in consensus client logs — explains that this is expected during initial sync, lists resolution steps (wait, check eth_syncing, verify engine RPC endpoint).
  2. Consensus and execution clients cannot connect — checklist covering Docker network, auth-RPC port (8551), and JWT secret alignment.
  3. Node stops after Docker daemon restart — guidance on docker ps, docker logs, and the role of autorestart=true in supervisord.conf.

Impact

Checklist

  • Docs-only change; no functional code modified.
  • Follows existing README formatting.
  • Addresses real operator pain points evidenced by open issues.

The Troubleshooting section only contained a Discord link. New operators
frequently report AwaitingELSyncCompletion as a bug (see issue base#1041)
and are confused when the consensus client repeatedly logs that it is
skipping derivation.

Add a dedicated troubleshooting guide covering:
- AwaitingELSyncCompletion: explain that it is expected during initial
  sync, not an error, and list resolution steps.
- EL/CL connection issues: checklist for Docker network, auth-RPC port,
  and JWT secret alignment.
- Docker daemon restart: guidance on verifying container state and the
  role of supervisord autorestart.

This reduces support burden and improves the first-run experience.
@cb-heimdall
Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants