Skip to content

fix: normalize internal links to use absolute paths and remove .md extensions#247

Merged
Hauke Löffler (hloeffler) merged 2 commits intomainfrom
fix/internal-links-redirects
Mar 6, 2026
Merged

fix: normalize internal links to use absolute paths and remove .md extensions#247
Hauke Löffler (hloeffler) merged 2 commits intomainfrom
fix/internal-links-redirects

Conversation

@hloeffler
Copy link
Contributor

Summary

  • Replace 21 symlink redirect paths (getting-started/ symlinks → canonical targets) so links resolve directly without redirects
  • Remove .md extensions from 21 internal links to follow VitePress routing convention
  • Convert 8 relative ../ links to absolute /multiplayer-servers/ paths for consistency
  • Fix 1 link text: "Using Agones SDK" → "Using the Agones SDK" (matching the page title)

Details

The multiplayer-servers/getting-started/ directory contains symlinks that redirect to canonical locations (e.g. using-the-agones-sdk.md../integration/your-game-server.md). Many internal links pointed through these symlinks instead of directly to the canonical path, causing unnecessary redirects.

Additionally, some links used .md extensions or relative ../ paths, inconsistent with the documented convention in AGENTS.md and copilot-instructions.md:

Internal doc links should start with / and omit .md (VitePress routing).

After this change, all internal page links in src/multiplayer-servers/ consistently use absolute paths starting with / and omit .md.

Verification

  • yarn docs:build passes via Docker (docker run --rm gamefabric-docs-dev yarn docs:build)
  • grep confirms zero remaining symlink path references, .md extensions, or ../ parent-directory links in internal page links

Files changed

25 files across src/multiplayer-servers/, 39 lines changed (pure find-and-replace, no content changes)

…tensions

- Replace 21 symlink redirect paths (getting-started/ symlinks) with canonical targets
- Remove .md extensions from 21 internal links (VitePress convention)
- Convert 8 relative ../ links to absolute /multiplayer-servers/ paths
- Fix 1 link text: 'Using Agones SDK' → 'Using the Agones SDK'

All internal page links now consistently use absolute paths starting
with / and omit .md, matching the documented convention in AGENTS.md
and copilot-instructions.md.

Verified via docker build (yarn docs:build).
@hloeffler Hauke Löffler (hloeffler) requested a review from a team as a code owner March 6, 2026 10:48
Copilot AI review requested due to automatic review settings March 6, 2026 10:48
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Normalizes internal documentation links in the src/multiplayer-servers/ VitePress docs to avoid symlink redirects, remove .md extensions, and improve consistency of routing.

Changes:

  • Repointed links away from getting-started/ symlink targets to canonical pages (notably Agones SDK docs).
  • Removed .md extensions from multiple internal links.
  • Converted some relative ../ links to absolute /multiplayer-servers/... paths (plus one link text tweak).

Reviewed changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
src/multiplayer-servers/production-workloads/requirements.md Updates Agones SDK doc link to canonical integration page.
src/multiplayer-servers/multiplayer-services/server-allocation/manually-registering-game-servers.md Removes .md from sidecar link and repoints Agones SDK doc link.
src/multiplayer-servers/multiplayer-services/server-allocation/integration-examples/gamelift.md Converts allocation guidance link to absolute and repoints Agones SDK doc link.
src/multiplayer-servers/multiplayer-services/server-allocation/integration-examples/flexmatch.md Converts allocation guidance link to absolute.
src/multiplayer-servers/multiplayer-services/server-allocation/automatically-registering-game-servers.md Repoints Agones SDK doc link and removes .md from API spec link.
src/multiplayer-servers/multiplayer-services/server-allocation/allocating-from-armadas.md Removes .md extensions from internal links in the allocation flow.
src/multiplayer-servers/multiplayer-services/game-server-wrapper.md Repoints Agones SDK reference to canonical integration page and updates link text.
src/multiplayer-servers/monitoring/introduction.md Repoints CCU tracking link to the new Agones SDK doc location.
src/multiplayer-servers/monitoring/auditlogs.md Converts permissions link to an absolute, extensionless route.
src/multiplayer-servers/integration/game-server-lifecycle.md Removes .md extension from server allocation registry link.
src/multiplayer-servers/hathora/index.md Repoints multiple Agones SDK references to canonical integration page.
src/multiplayer-servers/getting-started/terminating-game-servers.md Repoints Agones SDK doc link to canonical integration page.
src/multiplayer-servers/getting-started/terminating-armadasets.md Repoints Agones SDK doc link to canonical integration page.
src/multiplayer-servers/getting-started/setup-your-environment.md Converts Quotas link to absolute, extensionless route.
src/multiplayer-servers/getting-started/running-your-game-server.md Repoints Agones SDK references and removes .md extension from an internal link.
src/multiplayer-servers/getting-started/quickstart.md Repoints “Using the Agones SDK” link to canonical integration page.
src/multiplayer-servers/getting-started/pushing-container-images.md Removes .md extensions from same-directory links.
src/multiplayer-servers/getting-started/glossary.md Repoints Capacity Types, Agones SDK, and permissions links to canonical pages.
src/multiplayer-servers/getting-started/edit-a-branch.md Removes .md extension from an internal link-with-anchor.
src/multiplayer-servers/getting-started/deleting-container-images.md Removes .md extension from an internal link.
src/multiplayer-servers/getting-started/creating-an-armadaset.md Repoints Agones SDK reference to canonical integration page.
src/multiplayer-servers/getting-started/building-a-container-image.md Repoints Agones SDK reference and updates Quotas and next-step links.
src/multiplayer-servers/authentication/editing-permissions.md Removes .md extension from internal OAuth setup link.
src/multiplayer-servers/architecture/sidecars.md Repoints Agones SDK reference to canonical integration page.
src/multiplayer-servers/api/examples.md Converts relative prereq links to absolute, extensionless routes.

You can also share your feedback on Copilot code review. Take the survey.

- Fix broken anchors: #environment-name-length → #name-length, #container-user-id → #user-id
- Remove non-existent #player-count-and-capacity-tracking anchors from 2 links
- Convert bare relative link to absolute in pushing-container-images.md
- Remove double space in automatically-registering-game-servers.md
- Fix sidecar terminology: 'Allocator Sidecar' → 'Allocation Sidecar' (matches UI)
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 25 out of 25 changed files in this pull request and generated no new comments.


You can also share your feedback on Copilot code review. Take the survey.

@hloeffler Hauke Löffler (hloeffler) merged commit 95f735a into main Mar 6, 2026
9 checks passed
@hloeffler Hauke Löffler (hloeffler) deleted the fix/internal-links-redirects branch March 6, 2026 13:39
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.

4 participants