Repository navigation
Default docs to dev version; drop stable from version selector - #23
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #23 +/- ##
==========================================
- Coverage 95.09% 92.28% -2.82%
==========================================
Files 5 6 +1
Lines 306 350 +44
==========================================
+ Hits 291 323 +32
- Misses 15 27 +12 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
docs/make.jl: pass versions=["dev" => "dev", "v#.#"] to deploydocs so the gh-pages root redirects to ./dev/ and the outdated-version banner (DOCUMENTER_STABLE) points at dev. Released versions remain reachable via v#.# symlinks. canonical is left as the bare root URL. Documenter's canonical_url builds each page's canonical link as canonical + page path, with no version segment at all, so it already serves as the version-agnostic 'current' URL regardless of which version happens to be the deploydocs root redirect target (same builder script runs for every version build, dev and tagged releases alike). Pointing it at /dev would have made every released version's pages claim .../dev/... as their canonical URL too, which is wrong. A one-time companion change on the gh-pages branch (separate commit, see cb/gh-pages-stable-redirect) points the existing stable symlink at dev instead of a version directory, the same mechanism Documenter uses for other version aliases (v0.1 -> v0.1.4 etc.), so old /stable/<path> links keep working. Test results: Pkg.test() passed (all suites green, 350+ assertions). docs/make.jl built successfully locally (deployment auto-skipped outside CI, as expected); verified the built canonical link stays version-agnostic (.../MaterialModelsBase.jl/<page>, no /dev/ segment). Reviewed with an independent Codex read-only review (plan and final diff); no unresolved findings. Co-Authored-By: Claude Sonnet 5 <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
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.
What
docs/make.jl: passversions=["dev" => "dev", "v#.#"]todeploydocsso the gh-pages root redirects to./dev/and the outdated-version banner (DOCUMENTER_STABLE) points atdevinstead ofstable.v#.#symlinks (e.g.v0.1,v0.2).canonicalis left unchanged (bare root URL). Documenter'scanonical_urlbuilds each page's canonical link ascanonical + page path, with no version segment at all — it's already version-agnostic regardless of which version the root redirects to, since the samemake.jlruns for every version build (dev and tagged releases alike). Pointing it at/devwould have made every released version's pages claim.../dev/...as their canonical URL too, which is wrong.Backwards compatibility for
/stable/A companion one-time fix on the
gh-pagesbranch (#24) points the existingstablesymlink atdevinstead of a version directory — the same mechanism Documenter already uses for version aliases. Old/stable/<path>links, including deep links and assets, keep working transparently. Futuredeploydocsruns (with theversionssetting in this PR) regenerateversions.js/index.htmlbut do not touch thestablesymlink, so that fix persists going forward.Testing
Pkg.test(): all suites pass (350+ assertions).docs/make.jlbuilt successfully locally (deployment step auto-skipped outside CI, as expected); verified the builtcanonicallink stays version-agnostic (.../MaterialModelsBase.jl/<page>, no/dev/segment).🤖 Generated with Claude Code