Skip to content

fix(docs): make cross-guide links resolve and point GitHub links at master - #5

Merged
ValgulNecron merged 1 commit into
mainfrom
fix/docs-relative-links
Sep 28, 2026
Merged

ValgulNecron merged 1 commit into
mainfrom
fix/docs-relative-links

Conversation

@ValgulNecron

@ValgulNecron ValgulNecron commented Sep 28, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Fixes the two findings Greptile raised on ValgulNecron/Gameplane#520, the submodule bump to this site's HeroUI redesign.

  • Cross-guide links returned 404. Docs pages render at /docs/<slug>/ (with trailingSlash: "always"). A relative ./module-authoring/ link on /docs/console-protocols/ therefore pointed to /docs/console-protocols/module-authoring/.
    • All 165 cross-guide links in src/content/docs/*.mdx (markdown links and href="./…") now use ../<slug>/.
    • ../ keeps the /gameplane-website base path, which an absolute /docs/… link would drop.
  • GitHub links pointed at the wrong branch. Six links to Gameplane/blob/main and Gameplane/tree/main (security guide, CRD catalog, architecture, console protocols) now use master, Gameplane's default branch.

Verification

  • astro build succeeds (93 pages).
  • I resolved every href on every built dist/docs/** page against dist/. The only link that still fails is /docs/dashboard-tour/: src/pages/docs/[slug].astro filters that page out, but the sidebar, the docs index card, the previous/next links and installation.mdx all link to it. That one is left as it is here; it needs a separate decision.

🤖 Generated with Claude Code

https://claude.ai/code/session_01UshpSigdLccuYZi7oFJX9y


Generated by Claude Code

Summary by Sourcery

Correct documentation navigation links and align repository references with Gameplane's default branch.

Bug Fixes:

  • Fix broken cross-guide documentation links by resolving links between /docs/<slug>/ pages correctly while preserving the site's base path.
  • Update documentation links to the Gameplane repository so they target its master branch.

Tests:

  • Verify the documentation build succeeds and validate generated documentation links against the built site.

…aster

Docs pages render at /docs/<slug>/, so a relative ./other-guide/ link
resolved to /docs/<slug>/other-guide/ and 404ed. Every cross-guide link
now uses ../other-guide/, which keeps the site base path. Links into
the Gameplane repo used blob/main and tree/main; its default branch is
master.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UshpSigdLccuYZi7oFJX9y
Signed-off-by: Claude <noreply@anthropic.com>

@sourcery-ai sourcery-ai Bot 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.

Sorry @ValgulNecron, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 6 days and 23 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Sep 28, 2026

Copy link
Copy Markdown

Reviewer's Guide

This documentation-only change fixes 165 cross-guide links to account for trailing-slash routing and the /gameplane-website base path, updates six Gameplane GitHub references from main to master, and verifies the build plus generated-link resolution while documenting the remaining dashboard-tour issue.

Flow diagram for resolving cross-guide documentation links

flowchart LR
    Source["Docs source link"] --> Route["Rendered page with trailing slash"]
    Route --> Relative["../target-guide/"]
    Relative --> Base["/gameplane-website/docs/target-guide/"]
    Base --> Resolved["Guide resolves successfully"]
Loading

Flow diagram for documentation link verification

flowchart LR
    Build["astro build"] --> Dist["Generated dist/docs pages"]
    Dist --> Check["Resolve every href against dist/"]
    Check --> Pass["Cross-guide and GitHub links verified"]
    Check --> Exception["dashboard-tour remains unresolved"]
Loading

File-Level Changes

Change Details Files
Correct cross-guide URL resolution for the site's trailing-slash docs routes while preserving the deployed base path.
  • Replace relative ./<slug>/ links with ../<slug>/ across the MDX guides.
  • Update both Markdown links and inline HTML href attributes.
  • Retain the known /docs/dashboard-tour/ link to the filtered-out page for separate follow-up.
src/content/docs/*.mdx
Point repository documentation references at Gameplane's default master branch.
  • Update six GitHub blob/main and tree/main URLs to master for security, architecture, changelog, module-authoring, and CRD references.
src/content/docs/architecture.mdx
src/content/docs/changelog.mdx
src/content/docs/console-protocols.mdx
src/content/docs/crd-catalog.mdx
src/content/docs/security.mdx
Verify the generated documentation remains buildable and that generated internal links resolve.
  • Confirm astro build succeeds and produces 93 pages.
  • Resolve built-page links against dist/; identify only the pre-existing dashboard-tour mismatch.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@ValgulNecron
ValgulNecron merged commit ffefb29 into main Sep 28, 2026
2 checks passed
@ValgulNecron
ValgulNecron deleted the fix/docs-relative-links branch September 28, 2026 21:59
ValgulNecron referenced this pull request in GameplanePanel/Gameplane Sep 28, 2026
Moves website from 9e992a4 to ffefb29 (merge of ValgulNecron/gameplane-website#5): cross-guide
docs links now resolve (../<slug>/ instead of ./<slug>/) and links into
this repo point at master instead of main. Addresses both Greptile
findings on this PR.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UshpSigdLccuYZi7oFJX9y
Signed-off-by: Claude <noreply@anthropic.com>
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.

2 participants