ObolNetwork / ObolNetwork/obol-docs
Improve Documentation on Beacon Node API Flow and Debugging
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 27
- Forks
- 61
- Avg merge
- 1h 22m
- Merged PRs (30d)
- 2
Description
🎯 Problem to be solved
The documentation at https://docs.obol.tech/ lacks detailed information on understanding and debugging the API flow of different beacon node implementations.
🛠️ Proposed solution
Taking inspiration from the Runbook:
- For major beacon node implementations (Lighthouse, Prysm, Teku), create dedicated sections explaining API flow and internals
- Cover how beacon node processes API endpoints, steps in handling requests, common errors, debugging practices
- Provide code examples and diagrams illustrating API flow and component interactions
- Include troubleshooting guides and FAQs specific to each implementation, with step-by-step instructions
- Maintain documentation updates as new beacon node versions are released
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the documentation site and use the existing Runbook as the model. Scope dedicated sections for Lighthouse, Prysm, and Teku covering API flow, request handling, errors, debugging, examples, diagrams, troubleshooting, and FAQs. Done means these sections are published and include version-update guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100