fix: point footer "Guides" link at the guides index - #211
Open
mcollina wants to merge 1 commit into
Open
Conversation
The footer linked to docs/guides/movie-quotes-app-tutorial, a page that no longer exists upstream, so it 404'd in production. onBrokenLinks is set to 'warn', so the build never caught it. Point it at docs/guides instead — the How-to Guides index that the navbar already uses. Also add AGENTS.md documenting that docs/ and versioned_docs/ are generated from the upstream platformatic/platformatic repo and must not be edited here. Fixes #210 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
2 participants
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.
Fixes #210
Problem
The footer's Guides link pointed at
docs/guides/movie-quotes-app-tutorial, a page that no longer exists in the upstream docs, so it 404'd in production.It went unnoticed because
onBrokenLinksis set towarnindocusaurus.config.js— a dead nav/footer target builds and deploys cleanly and only fails for real users.Fix
Point it at
docs/guides, the How-to Guides index that the navbar's "How-to Guides" item already links to.Verification
npm run buildsucceeds, and the built footer now renders:build/docs/guides/index.htmlexists.Also included
An
AGENTS.mdcapturing the non-obvious bits of this repo — chiefly thatdocs/,versioned_docs/,versioned_sidebars/,sidebars.jsonandversions.jsonare committed but machine-generated fromplatformatic/platformaticrelease tags, so doc prose edits made here are silently discarded on the next deploy. Happy to split this out if you'd rather keep the PR to the one-line fix.Out of scope
The archived
2.75.2docs still contain in-page prose links tomovie-quotes-app-tutorial. That content is generated from the upstreamv2.75.2tag and can't be corrected from this repo.🤖 Generated with Claude Code