fix: correct documentation URLs in README (add missing /hw/ path) #293
+2
−2
Conversation
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
The documentation URLs for Snitch core and Snitch cluster were missing the /hw/ path segment. Updated: - rm/snitch.html -> rm/hw/snitch.html - rm/snitch_cluster.html -> rm/hw/snitch_cluster.html This aligns with the actual documentation structure defined in mkdocs.yml.
VedantPahariya
requested review from
colluca,
fischeti and
paulsc96
as code owners
There was a problem hiding this comment.
Pull request overview
This PR fixes broken documentation URLs in README.md by adding the missing /hw/ path segment, aligning them with the actual documentation structure defined in mkdocs.yml.
- Updated two documentation links to include the correct
/hw/path segment - Changes ensure users are directed to the correct documentation pages for the Snitch core and Snitch cluster
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fixed incorrect documentation URLs in README.md that were missing the
/hw/path segment.Changes:
This aligns with the actual documentation structure defined in mkdocs.yml and have confirmed no other files have similar issues.