docs(claude): document Pages source-path requirement (#55) - #56
Merged
Conversation
Captures the silent-stale-deploy trap discovered while investigating #53: mkdocs gh-deploy writes to gh-pages root, but the Pages source-path setting in repo settings was set to /docs. The pages-build-deployment workflow fails at dir_chdir0 - /github/workspace/docs and Pages keeps serving the previous artifact, so the live site looks merely "stale" instead of broken. Adds a Pages-source subsection under "Docs site" with the correct config, the diagnostic commands to use when a deploy looks absent, and the API call to repair the setting. Closes #55 Co-Authored-By: Claude <noreply@anthropic.com>
The version-bump CI check requires every PR to add a CHANGELOG entry. Documents the same change as the CLAUDE.md update. Refs #55 Co-Authored-By: Claude <noreply@anthropic.com>
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
1 participant
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.
Summary
Closes #55. Adds a Pages-source subsection to CLAUDE.md documenting the silent-stale-deploy trap we hit while investigating #53.
`mkdocs gh-deploy` writes the built site (with `.nojekyll`) to the root of `gh-pages`. If the GitHub Pages source path in repo settings is set to `/docs` instead of `/`, the separate `pages-build-deployment` workflow fails at `dir_chdir0 - /github/workspace/docs`, and Pages keeps serving the previously-published artifact — so the live site looks merely "stale" rather than broken. The setting has already been corrected; this just documents the requirement and a diagnostic flow so the next contributor (or future-Claude) doesn't re-investigate it.
No code changes — single `CLAUDE.md` edit, +33 lines.
Test plan
Co-authored by Claude