docs: document degu v0.1.5 as a release - #71
Merged
Conversation
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
Stabilizes the release-facing documentation so the v0.1.5 tag will not carry pre-release, self-contradictory wording. The README and the installation, usage, and safety guides all now state plainly that they document degu v0.1.5 and tell readers on a different binary to use the docs tagged for their version, instead of the previous "unreleased v0.1.5 / next release / latest published is v0.1.4" phrasing that would be permanently wrong once tagged (and, via
readme = "../../README.md", would make the crates.iodegu 0.1.5page claim to be unreleased). Specifically:v0.1.4documentation links (which framed v0.1.4 as the current release) are replaced with version-matched relative links (docs/installation.md), so the tagged README points at the matching tag's guides rather than a hardcoded older version.docs/installation.md,docs/usage.md, anddocs/safety.mdbanners rewritten the same way ("This guide documents degu v0.1.5 … use the guide tagged for your version").No code, CLI, or behavior changes — documentation wording and links only.
Validation
cargo fmt --all -- --check— clean.cargo test --workspace --all-features --locked— all green, including the byte-exact README contract test (the pinned scan-output block is unchanged).--include-fragments) — 0 errors; the new relative links resolve to the local guides and theTool-native reclaimfragment resolves against the localdocs/usage.md.Safety
None. This changes only documentation prose and links; no scan, clean, staging, undo, purge, quota, relocate, or path/symlink behavior changes, and no code is touched.