You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: reconcile gh and process module stability statements across README, API contract, and manifest #553
Give every document one accurate statement of the gh and process modules' stability and release membership, so the v2.2.0 release notes and API reference can be written without contradictions.
Background
The documents disagree about two modules:
gh
README.md:42-46 and lib/bash/README.md:16-19 describe gh as "Preview-only ... on main".
base_api_manifest.yaml on main declares ghstability: stable, since: 2.0.0; docs/v2-api-contract.md:112,220 and lib/bash/gh/README.md:16 say the same. (The v2.1.0 tag's manifest declared gh as preview/unreleased, so the published v2.1.0 contract differs from main.)
process
README.md:244 and lib/bash/process/README.md:8-10 say it is included in the immutable v2.1.0 release.
docs/v2/architecture.md:14 says "unreleased ... not in v2.0.0"; docs/v2-api-contract.md:110,214 say "preview addition on main" / "preview, unreleased"; lib/bash/README.md:11-12 says it is "not included in the v2.0.0 GA release" (true but implies it is only on main).
base_api_manifest.yaml and docs/api-reference.md:113 use since: unreleased for process, while docs/api-manifest-schema.md:48 says unreleased applies only "until a release containing it is published". v2.1.0 contains it.
Scope
Maintainer decision first: is gh stable on main for v2.2.0, and is process still preview with since: 2.1.0?
Update the manifest, regenerate docs/api-reference.md, and align README, lib/bash/README.md, docs/v2/architecture.md, docs/v2-api-contract.md, and the gh/process READMEs with that decision.
Clarify in the schema doc what since records for a preview module that has shipped.
Acceptance Criteria
One consistent stability + first-release statement for gh and process in every document that mentions them.
Manifest since values follow the documented schema rule; generated API reference regenerated and scripts/api-manifest check passes.
Release invariants against the published baseline still pass.
The decision is recorded in the changelog's v2.2.0 notes.
Assignee: @codeforester. Found during the pre-release documentation walkthrough of 2026-10-07 at the origin/main heads of base-bash-libs (454aabc) and base-bash-libs-demo (5e598be). No repository content was changed by the review.
Activity