Skip to content

Conversation

@nblock
Copy link
Collaborator

@nblock nblock commented Mar 21, 2025

  • Rename exit-node to routes and add redirects
  • Add a new section on subnet routers
  • Extend the existing exit-node documentation
  • Describe auto approvers for subnet routers and exit nodes
  • Provide ACL examples for subnet routers and exit nodes
  • Describe HA and its current limitations
  • Add a troubleshooting section with IP forwarding

  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md

@nblock nblock mentioned this pull request Mar 21, 2025
6 tasks
@nblock nblock added this to the v0.26.0 milestone Mar 21, 2025
@nblock nblock force-pushed the routedocs branch 2 times, most recently from 5797d31 to 20e2f78 Compare March 28, 2025 06:38
@ghost
Copy link

ghost commented May 1, 2025

Pull Request Revisions

RevisionDescription
r2
Added comprehensive routes documentationCreated a new detailed routes.md documentation covering subnet routers, exit nodes, auto-approvers, and related configuration details
r1
Added comprehensive routes documentationCreated a new detailed documentation file for routes, covering subnet routers, exit nodes, and related configuration details

✅ AI review completed for r2
Help React with emojis to give feedback on AI-generated reviews:
  • 👍 means the feedback was helpful and actionable
  • 👎 means the feedback was incorrect or unhelpful
💬 Replying to feedback with a comment helps us improve the system. Your input also contributes to shaping future interactions with the AI reviewer.

We'd love to hear from you—reach out anytime at [email protected].

@nblock nblock marked this pull request as ready for review May 1, 2025 06:34
nblock added 3 commits May 1, 2025 14:36
* Rename exit-node to routes and add redirects
* Add a new section on subnet routers
* Extend the existing exit-node documentation
* Describe auto approvers for subnet routers and exit nodes
* Provide ACL examples for subnet routers and exit nodes
* Describe HA and its current limitations
* Add a troubleshooting section with IP forwarding
Add auto approvers and link to our documentation if available.
Comment on lines +137 to +138
// more rules
]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JSON comments in the ACL examples (lines 137-138 and 255-256) use JavaScript-style comments (// more rules). JSON doesn't technically support comments, so while this works for documentation, it might be confusing if users try to copy and paste these examples directly. Consider using a proper JSON format or adding a note that these comments should be removed before use.

Copy link
Collaborator

@kradalby kradalby left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!, thank you!

@kradalby kradalby merged commit 18d21d3 into juanfont:main May 3, 2025
139 of 144 checks passed
@nblock nblock deleted the routedocs branch May 3, 2025 08:46
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

Successfully merging this pull request may close these issues.

2 participants