docs: release/consuming/engineering-notes guides + ADRs; refresh stale docs - #96
Merged
Conversation
Reflect the completed roadmap and the new release pipeline into the docs, and capture decisions and conventions that previously lived only in code and commit history. New docs: - docs/releasing.md — versioning posture (semver, pre-1.0) and how a release is cut (push a v* tag → GoReleaser), plus the pipeline-maintenance constraints (the ~> v2 pin and modern ids/formats fields, goreleaser-action@v7 / Node 24, validating config with `goreleaser check`). - docs/consuming.md — using the CLIs from scripts/agents: install from a release (with checksum verification), the verbatim-JSON output contract, exit-code branching, --all/result_truncated handling, and non-interactive use. - docs/engineering-notes.md — contributor conventions and gotchas: validate-before-auth ordering, the nil-body-marshals-"null" trap, the reusable-helper inventory, the destructive-verb rule, and local gates. - docs/adr/ — six ADRs (per-category exit codes [D1], the shared foundation and what is deliberately not shared [D2], destructive verbs require --yes [D3], the mixed-version Confluence client, keychain-first token storage, and verbatim JSON / no fake parity) plus an index. Refreshed: - command-contract.md — replaced the stale phase-by-phase Scope intro with a capability-organized summary + capability matrix; expanded `version`. - README.md — corrected the per-CLI status bullets (conf delete/ancestors/ versions/blogpost, bb write parity, jira attachments), added install-from- release, refreshed the living-docs list. - docs/README.md, AGENTS.md, CONTRIBUTING.md — indexed the new docs, extended the read-order, and added the --yes / validate-before-auth invariants and the docs-check / releasing pointers. Co-Authored-By: Claude Opus 4.7 (1M context) <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
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.
Acts on the documentation-gap reflection: documents the new release pipeline, adds consumer- and contributor-facing guides, captures standing decisions as ADRs, and refreshes the docs that had drifted as the roadmap completed.
New docs
docs/releasing.md— versioning posture (semver, pre-1.0) and how to cut a release (push av*tag → GoReleaser). Records the non-obvious pipeline constraints: the~> v2pin + modernids/formatsarchive fields (don't downgrade),goreleaser-action@v7/Node 24, and validating config withgoreleaser check.docs/consuming.md— using the CLIs from scripts/agents: install from a release (with checksum verification), the verbatim-JSON output contract, exit-code branching (with acase $?example),--all/result_truncated, and non-interactive use.docs/engineering-notes.md— the conventions/gotchas that lived only in code and review history: validate-before-auth ordering, the nil-body marshals"null"trap, the reusable-helper inventory, the destructive-verb rule, and the local gates.docs/adr/— six ADRs + index: 0001 per-category exit codes (D1), 0002 shared foundation & deliberately-not-shared (D2), 0003 destructive verbs require--yes(D3), 0004 mixed-version Confluence client, 0005 keychain-first token storage, 0006 verbatim JSON & no fake parity.Refreshed
command-contract.md— replaced the stale phase-by-phase Scope intro (it stopped at Phase 8) with a capability-organized summary + a capability matrix; expanded theversionsection with the JSON shape.README.md— corrected the per-CLI status bullets (conf delete/ancestors/versions/blogpost, bb write parity, jira attachments), added an install-from-release section, refreshed the living-docs list.docs/README.md,AGENTS.md,CONTRIBUTING.md— indexed the new docs, extended the read-order, and added the--yes/validate-before-auth invariants plus thedocs-check/releasing pointers.Validation
make check+make docs-checkgreen.codexrabbit-code-reviewer(verdict: correct); two minor wording findings addressed.No code changes.
🤖 Generated with Claude Code