Skip to content

Fix broken internal documentation links using canonical routes - #49

Open
Amanyadav0556 wants to merge 1 commit into
ContextVM:masterfrom
Amanyadav0556:vm-issue
Open

Fix broken internal documentation links using canonical routes#49
Amanyadav0556 wants to merge 1 commit into
ContextVM:masterfrom
Amanyadav0556:vm-issue

Conversation

@Amanyadav0556

Copy link
Copy Markdown

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:

/src/content/docs/spec/ceps/cep-22.md

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

File Changes
reference/ceps/cep-41.md Fixed 6 broken /src/content/docs/spec/ceps/ links by replacing them with canonical documentation routes.
reference/ceps/cep-22.md Fixed 2 broken src/content/docs/spec/ceps/ links by updating them to valid routes.
reference/ts-sdk/core/logging.md Removed 6 malformed label-links and fixed 1 incorrect "See Also" reference.
reference/ts-sdk/transports/nostr-client-transport.md Removed 7 broken self-referential links and fixed 1 CEP-17 reference.

Why

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

[CEP-22](/src/content/docs/spec/ceps/cep-22.md)

❌ Results in:

404 Not Found

After

[CEP-22](/reference/ceps/cep-22)

✅ Resolves correctly to the published documentation page.

Changes Made

  • Replaced filesystem-based documentation links with canonical routes.
  • Removed invalid self-referential links that generated broken navigation.
  • Fixed malformed Markdown links.
  • Preserved existing documentation content, formatting, and references.
  • Followed Astro/Starlight internal linking conventions.

Testing

  • Verified all updated links resolve to valid documentation routes.
  • Confirmed all referenced documentation pages exist.
  • Searched affected files to ensure no remaining /src/content/docs/ links exist.
  • Verified Markdown formatting remains valid.
  • Confirmed no frontmatter, code examples, or unrelated content were modified.

Impact

  • Fixes broken internal navigation on the published documentation website.
  • Improves documentation reliability and contributor experience.
  • Makes cross-references between specifications and SDK documentation work correctly.
  • No runtime code, API behavior, or application functionality is affected.

Related Issue

Fixes #48

…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.
Copilot AI lite review requested due to automatic review settings August 6, 2026 22:18
@vercel

vercel Bot commented Aug 6, 2026

Copy link
Copy Markdown

@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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

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.

Fix broken internal documentation links by replacing source paths with canonical routes

2 participants