docs: fix stale publish/version claims, add mise install docs - #28
Merged
Conversation
Audit against the published 0.5.2 release found stale "publishing soon" language, out-of-date @0.4.0 example pins, and a missing mise install method on the docs site that both READMEs already lead with. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 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.
Summary
Fixes documentation accuracy/completeness defects found by an audit against
the published
0.5.2release:README.md: removed stale "(Publishing soon; the commands below are theshape of it.)" parenthetical — the package is published.
README.md: bumpedmise use github:aligned-team/cospec@0.4.0example to@0.5.2.apps/cli/README.md: removed stale "Publishing soon." line (this READMEships to npm).
apps/cli/README.md: bumped@0.4.0example to@0.5.2.apps/docs/guide/installation.md: added a "Via mise" subsection first(before package managers), matching both READMEs' lead install path —
includes the self-contained-binary note and the
minimum_release_agecooldown caveat with the exact-pin workaround.
apps/docs/index.md: added a mise tab (first) to the quickstartcode-group, consistent with installation.md.
docs/release.md:49: bumped@0.4.0example pin to@0.5.2.docs/harness-integration.md:110: replacedcospec@0.1.0with aversion-placeholder form consistent with current usage.
Shipped as a
docs-typed cospec change (docs-site-accuracy-pass), archivedas the final commit on this branch.
Out of scope (follow-ups, not fixed here)
templates --helpmissing--schemaoption.Test plan
mise run docs:build— site builds cleanmise run check— lint, format, typecheck, unit/contract/integrationtests, schema validate, agents:check, generate:check all pass
🤖 Generated with Claude Code