Repository navigation
docs: align public guidance with v2 release candidate - #218
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Aligns public documentation with the shipped v2 release candidate:
mainnow installs the prerelease explicitly, links to the versionednextdocs instead of stable v1 docs, and describes the v2 API as shipped in RC rather than merely planned. It also fixes docs workflow behavior so concurrent PR previews do not cancel each other and prerelease tags retain their full version without taking thelatestalias.Related issue
None
Test plan
just check— Ruff, rumdl, mypy, and 450 non-API tests passed.uv run mkdocs build --strict --clean— strict docs build passed.actionlint .github/workflows/docs.yml— passed.v2.0.0-rc.1,v2.0.0, andv1.8.1; results were respectively2.0.0-rc.1with no aliases,2.0withlatest, and1.8withv1.git diff --checkpasses.Notes
The GitHub
github-pagesenvironment previously allowed onlymain, which rejected thev2.0.0-rc.1tag deployment and would also rejectv1. Its deployment policies have been updated separately to allow onlymain, branchv1, and tags matchingv*.The failed RC deployment was protective in hindsight: the old workflow would have shortened
v2.0.0-rc.1to2.0.0-rcand promoted it tolatest. This change prevents prerelease tags from changing the stable docs default.just checkpasses