Skip to content

Describe main as v0.8.0 without the pre-release - #280

Merged
soareschen merged 1 commit into
mainfrom
ai-updates-20261006
Oct 11, 2026
Merged

soareschen merged 1 commit into
mainfrom
ai-updates-20261006

Conversation

@soareschen

Copy link
Copy Markdown
Collaborator

This PR makes cgp's README and AGENTS.md describe the main branch as the v0.8.0 release, as
though v0.8.0 had already shipped. It removes every note about the pre-release crates published on
the way to v0.8.0. That brings the repository in line with the knowledge base's
rule on versions,
which the knowledge base, the /cgp skill, and cargo-cgp's README already follow. The change
edits documentation in two files and leaves code, tests, and snapshots untouched.

The edits are correct under that rule. But until v0.8.0 and cargo-cgp v0.1.0 are published, the
README's install commands give a reader the wrong versions, so this PR should merge with those
releases. Merge timing explains why.

What changes

README

The README now addresses a reader of v0.8.0 and stops explaining how to reach v0.8.0 before its
release. It changes in these places:

  • Version banner: states that the repository describes v0.8.0, that v0.8.0 is incompatible with
    v0.7.0, and where the v0.7.0 documentation lives. It drops the statement that main tracks an
    upcoming release published as pre-release crates.
  • Installation note: removed. The note warned that cargo add cgp installs v0.7.0 and told the
    reader to depend on main through a git dependency until v0.8.0 shipped. The section now ends
    with cargo add cgp and the prelude import.
  • cargo-cgp paragraph: pins the nix run flake reference to the v0.1.0 tag and calls the
    tool "an early release" instead of a pre-release.
  • Project status: drops the statement that v0.8.0 is a pre-release and keeps the point that CGP
    is young and still evolving.

AGENTS.md

The project-status section now states the documentation rule for agents directly. The tree is
v0.8.0, and its manifests may carry a pre-release suffix while the release process is tested. Every
document, comment, and README describes the tree as v0.8.0 and never names that suffix. The section
links the knowledge-base rule and applies it to every sibling crate, including cargo-cgp v0.1.0.

Two smaller edits follow from that rule. The v0.7.0 paragraph calls v0.7.0 "the previous official
release" instead of "the stable release on crates.io". The workspace-versioning convention names
the lockstep version as 0.8.0 instead of quoting the manifests' current suffix.

The README drops the note on the published pre-release crates and the instruction to depend on main,
and AGENTS.md's project status describes the tree as v0.8.0, with pre-release versions treated as
test runs that no document names.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@soareschen soareschen added the AI label Oct 11, 2026
@soareschen
soareschen merged commit eca0c5f into main Oct 11, 2026
3 checks passed
@soareschen
soareschen deleted the ai-updates-20261006 branch October 11, 2026 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant