fix: generate GitHub-compatible RPC doc anchors#5136
Merged
zhangsoledad merged 1 commit intonervosnetwork:developfrom Mar 23, 2026
Merged
fix: generate GitHub-compatible RPC doc anchors#5136zhangsoledad merged 1 commit intonervosnetwork:developfrom
zhangsoledad merged 1 commit intonervosnetwork:developfrom
Conversation
eval-exec
requested review from
Copilot and
doitian
and removed request for
a team
There was a problem hiding this comment.
Pull request overview
This PR fixes broken intra-document links in the generated RPC documentation on GitHub by updating rpc-gen to produce GitHub-compatible heading anchor slugs for generic type names (e.g., ResponseFormat<HeaderView>).
Changes:
- Update anchor slug generation to match GitHub’s heading anchor behavior for generic type names.
- Add unit tests validating anchor generation for generic and non-generic type names.
- Regenerate
rpc/README.mdso all affected links use the new anchors.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
devtools/doc/rpc-gen/src/gen.rs |
Changes type_name_to_anchor to a GitHub-compatible slugger for type headings and adds unit tests. |
rpc/README.md |
Regenerated RPC docs updating links from _for_-based anchors to GitHub-compatible anchors. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
chenyukang
approved these changes
Mar 10, 2026
doitian
approved these changes
Mar 10, 2026
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
zhangsoledad
approved these changes
Mar 23, 2026
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What problem does this PR solve?
Problem Summary:
Generated anchors for generic RPC doc types use
_for_, so links likeResponseFormat<HeaderView>are broken on GitHub.What is changed and how it works?
What's Changed:
Generate GitHub-compatible heading anchors in
rpc-gen, add a unit test, and regeneraterpc/README.md.Related changes
None.
Check List
Tests