docs: sweep deep docs to release-on-merge-first framing (#17)#36
Merged
Conversation
The headline docs already lead with release-on-merge and present the Release PR as a variant; this sweeps the deeper docs to match, keeping "Release PR" as a named variant rather than the canonical flow. - guides/cut-a-release.md — reframe TL;DR and Step 3/4 to lead with release-on-merge; add a "Release PR variant" section and a workflow-neutral "What to review" subsection. - specs/walkthrough.md, specs/language.md (term + algebra note), specs/v1-scope.md, specs/cli.md — note the Release PR is one of two workflows (release-on-merge default). - Light reword of the "Release PR" source comments in version.ts, git/mod.ts, git/commit.ts for consistency (comments only). Docs build clean; deno task verify passes (comment-only code edits). Closes #17. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ben-laird
force-pushed
the
docs/issue-17-release-on-merge-sweep
branch
from
adf0723 to
faa6e9c
Compare
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
1 participant
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.
Closes #17.
The headline docs (README, docs index, getting-started, ci-integration) already lead with release-on-merge and present the Release PR as a variant. This sweeps the long-tail deeper docs to match — keeping "Release PR" as a named variant, not the canonical flow.
Changes
guides/cut-a-release.md(the big one) — reframed the intro, TL;DR, and Step 3/4 to lead with release-on-merge (both phases run in CI on merge tomain). Added a dedicated "The Release PR variant" section for teams gating the bump on review, and renamed "Reviewing the Release PR" → "What to review (either workflow)".specs/walkthrough.md— the bump commit lands onmainautomatically by default; Release PR is the gated alternative.specs/language.md— kept the Release PR term; noted it's one of two workflows (added to both the lexicon entry and the two-phase algebra note).specs/v1-scope.md— the GitHub Actions companion is release-on-merge CI by default; the user-journey step is now workflow-neutral.specs/cli.md— thedv versioncommit lands onmainunder release-on-merge or is reviewed as a Release PR when gating.version.ts,git/mod.ts,git/commit.ts— light reword to "version-bump commit (the Release PR in a review-gated workflow)". Comments only; no behavior change.Every remaining "Release PR" mention is now framed as the variant. VitePress build is clean (no broken links);
deno task verifypasses (the only code changes are comments). Docs-only — no Record.🤖 Generated with Claude Code