Skip to content
This repository was archived by the owner on Jan 16, 2026. It is now read-only.

Conversation

@theochap
Copy link
Member

@theochap theochap commented Jan 9, 2026

Summary

  • Remove broken kurtosis sidebar links that had no corresponding documentation files
  • Replace inaccurate Supervisor/Runtime Actor descriptions with accurate L1 Watcher Actor documentation
  • Fill in TODO sections for Node Identification (ENR validation) and P2P Actor (NetworkActor) in p2p.mdx
  • Fix outdated crate references: kona-nodekona-node-service, kona-p2pkona-disc

Test plan

  • Docs build successfully with npm run build
  • Review rendered documentation for accuracy

🤖 Generated with Claude Code

theochap and others added 2 commits January 9, 2026 13:18
- 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>
Copilot AI review requested due to automatic review settings January 9, 2026 19:35
Copy link
Contributor

Copilot AI left a 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-node to kona-node-service and kona-p2p to kona-disc to 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.

Comment on lines +192 to +193
[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
Copy link

Copilot AI Jan 9, 2026

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).

Suggested change
[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

Copilot uses AI. Check for mistakes.
@codecov
Copy link

codecov bot commented Jan 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.0%. Comparing base (2845953) to head (ddbda91).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

❗ There is a different number of reports uploaded between BASE (2845953) and HEAD (ddbda91). Click for more details.

HEAD has 22 uploads less than BASE
Flag BASE (2845953) HEAD (ddbda91)
unit 2 1
proof 11 0
e2e 10 0

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants