Fix broken internal documentation links using canonical routes - #49
Open
Amanyadav0556 wants to merge 1 commit into
Open
Fix broken internal documentation links using canonical routes#49Amanyadav0556 wants to merge 1 commit into
Amanyadav0556 wants to merge 1 commit into
Conversation
…oc routes - cep-41.md: fix 6 broken /src/content/docs/spec/ceps/ links - cep-22.md: fix 2 broken src/content/docs/spec/ceps/ links - logging.md: remove 6 malformed AI-artifact label links, fix See Also link - nostr-client-transport.md: remove 7 self-referential broken links, fix cep-17 link All updated hrefs verified against filesystem and astro.config.mjs sidebar slugs.
|
@Amanyadav0556 is attempting to deploy a commit to the ContextVM's projects Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to use Astro/Starlight canonical internal routes (page slugs) instead of repository filesystem paths, eliminating internal links that would 404 on the published site.
Changes:
- Replaced filesystem-based CEP links with canonical
/reference/...routes in CEP-41 and CEP-22. - Cleaned up malformed/self-referential links in TS SDK transport and logging docs, replacing them with plain identifiers or correct canonical links.
- Updated a “See also” reference to point at the correct Core Interfaces route.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/content/docs/reference/ceps/cep-41.md | Updates CEP cross-links (CEP-22, CEP-35) to canonical /reference/ceps/... routes. |
| src/content/docs/reference/ceps/cep-22.md | Fixes CEP-6 and CEP-19 references to use canonical /reference/ceps/... routes. |
| src/content/docs/reference/ts-sdk/core/logging.md | Removes malformed label-links and fixes “See also” to /reference/ts-sdk/core/interfaces. |
| src/content/docs/reference/ts-sdk/transports/nostr-client-transport.md | Removes broken self/filepath links and updates CEP-17 reference to /reference/ceps/cep-17. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
This PR fixes broken internal documentation links that referenced repository filesystem paths instead of the canonical routes generated by the Astro/Starlight documentation site.
Previously, links such as:
resolved to 404 Not Found errors on the published documentation site because Astro/Starlight generates routes from documentation page slugs rather than repository file paths.
This change updates those references to use valid public documentation routes, improving navigation reliability across the documentation site.
Files Modified
reference/ceps/cep-41.md/src/content/docs/spec/ceps/links by replacing them with canonical documentation routes.reference/ceps/cep-22.mdsrc/content/docs/spec/ceps/links by updating them to valid routes.reference/ts-sdk/core/logging.mdreference/ts-sdk/transports/nostr-client-transport.mdWhy
Astro/Starlight generates documentation URLs from page slugs, not repository filesystem paths. Links pointing to
src/content/docs/expose internal repository structure and do not exist on the deployed documentation website.Example
Before
❌ Results in:
After
✅ Resolves correctly to the published documentation page.
Changes Made
Testing
/src/content/docs/links exist.Impact
Related Issue
Fixes #48