-
Notifications
You must be signed in to change notification settings - Fork 212
docs: fix broken links and update node design documentation #3239
base: main
Are you sure you want to change the base?
Conversation
- Remove broken kurtosis sidebar links (no corresponding files exist) - Replace Supervisor/Runtime Actor descriptions with accurate L1 Watcher Actor - Fill in TODO sections for Node Identification and P2P Actor in p2p.mdx - Fix crate references: kona-node -> kona-node-service, kona-p2p -> kona-disc - Remove orphaned TODO link reference in registry.mdx Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR addresses documentation issues by removing broken links and filling in previously incomplete sections with accurate technical documentation.
- Removes broken Kurtosis sidebar links that had no corresponding documentation files
- Updates crate references from
kona-nodetokona-node-serviceandkona-p2ptokona-discto match actual crate names - Fills in TODO sections with comprehensive documentation for Node Identification (ENR validation) and P2P Actor (NetworkActor)
- Replaces inaccurate Supervisor/Runtime Actor descriptions with accurate L1 Watcher Actor documentation
- Updates CLAUDE.md with improved build commands and architecture documentation
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/vocs.config.ts | Updates Rustdocs link from deprecated kona-node to correct kona-node-service crate |
| docs/sidebar.ts | Removes non-existent Kurtosis integration links from sidebar |
| docs/docs/pages/sdk/protocol/registry.mdx | Removes broken TODO link reference |
| docs/docs/pages/sdk/overview.mdx | Corrects crate name from kona-node to kona-node-service in example |
| docs/docs/pages/node/design/p2p.mdx | Adds comprehensive documentation for Node Identification and P2P Actor; updates crate reference from kona-p2p to kona-disc |
| docs/docs/pages/node/design/intro.mdx | Replaces outdated Supervisor/Runtime Actor descriptions with accurate L1 Watcher Actor documentation |
| CLAUDE.md | Updates build commands, architecture overview, and project structure documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| [opstack-enr]: https://docs.rs/kona-p2p-peers/latest/kona_p2p_peers/struct.OpStackEnr.html | ||
| [enr-validation]: https://docs.rs/kona-p2p-peers/latest/kona_p2p_peers/enum.EnrValidation.html |
Copilot
AI
Jan 9, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The crate name in the docs.rs URLs is incorrect. The crate is named 'kona-peers', not 'kona-p2p-peers'. The URLs should use 'kona-peers' and 'kona_peers' (with underscores in the module path).
| [opstack-enr]: https://docs.rs/kona-p2p-peers/latest/kona_p2p_peers/struct.OpStackEnr.html | |
| [enr-validation]: https://docs.rs/kona-p2p-peers/latest/kona_p2p_peers/enum.EnrValidation.html | |
| [opstack-enr]: https://docs.rs/kona-peers/latest/kona_peers/struct.OpStackEnr.html | |
| [enr-validation]: https://docs.rs/kona-peers/latest/kona_peers/enum.EnrValidation.html |
Codecov Report✅ All modified and coverable lines are covered by tests.
☔ View full report in Codecov by Sentry. |
Summary
kona-node→kona-node-service,kona-p2p→kona-discTest plan
npm run build🤖 Generated with Claude Code