ObolNetwork / ObolNetwork/obol-docs
Update peer discovery page to reflect relay model
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
We've changed how peering works from when this was written https://docs.obol.tech/docs/charon/peer-discovery
- Link to the codebase issue that prompted this docs change
🛠️ Proposed solution
Update it to reflect the relay model.
Also remove the UDP 3630 port on the charon introduction page.
- For major overhaul of docs, design doc link:
🧪 Tests
- Netlify deployment build tests passing
👐 Additional acceptance criteria
❌ Out of Scope
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 with the peer discovery page at docs.obol.tech/docs/charon/peer-discovery and identify the codebase issue that prompted the change. Update the page to describe the relay model, remove UDP port 3630 from the Charon introduction page, and verify that the Netlify deployment build passes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100