Add linking and references guide #2836
Merged
+187
−0
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.
Created a comprehensive guide on linking and references in documentation, covering internal links, anchor links, API endpoint references, and link maintenance best practices. Added the new guide to the Best practices section in the Guides navigation.
Files changed:
guides/linking-and-references.mdx- New comprehensive guide on linking strategiesdocs.json- Added new page to Best practices group navigationNote
Adds a new docs best-practice guide and wires it into navigation.
guides/linking.mdxcovering internal links, anchor links, external links, API endpoint references, redirects, and broken-link checksdocs.jsonto includeguides/linkingin the Guides → Best practices groupguides/index.mdxto list and describe the new Linking guideWritten by Cursor Bugbot for commit a2559bb. This will update automatically on new commits. Configure here.