Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation on Beacon Node API Flow and Debugging #345

Open
5 tasks
boulder225 opened this issue Apr 2, 2024 · 0 comments
Open
5 tasks

Improve Documentation on Beacon Node API Flow and Debugging #345

boulder225 opened this issue Apr 2, 2024 · 0 comments

Comments

@boulder225
Copy link
Contributor

🎯 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
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

No branches or pull requests

1 participant