-
Notifications
You must be signed in to change notification settings - Fork 0
[Epic] Documentation, governance, and distribution readiness #33
Copy link
Copy link
Closed
6 / 66 of 6 issues completedClosed
6 / 66 of 6 issues completed
Copy link
Labels
P1Significant semantic, completeness, correctness issues.Significant semantic, completeness, correctness issues.component: docsREADME, specifications, security, and contributor documentationREADME, specifications, security, and contributor documentationdiscovered-by-codexIssues discovered via review by codex.Issues discovered via review by codex.domain: distributionCrates.io, GitHub Releases, Homebrew, and installable artifactsCrates.io, GitHub Releases, Homebrew, and installable artifactsdomain: governanceProject policy, support, ownership, and release authorityProject policy, support, ownership, and release authoritydomain: usabilityCLI experience, diagnostics, installation, and contributor experienceCLI experience, diagnostics, installation, and contributor experienceepicOrganizing issue that tracks a coherent remediation workstreamOrganizing issue that tracks a coherent remediation workstreamproduction-readinessPart of the audited path from prototype to production-ready usePart of the audited path from prototype to production-ready userelease-blockerMust close before the production-readiness release gate can passMust close before the production-readiness release gate can passtarget: v0.2.0Must be resolved or explicitly waived before the v0.2 production auditMust be resolved or explicitly waived before the v0.2 production auditworkflow:production-readinessIncluded in automatic production-readiness work selectionIncluded in automatic production-readiness work selectionworkflow:production-readiness-gateEpic, audit, publication, or program gate requiring landed prerequisitesEpic, audit, publication, or program gate requiring landed prerequisites
Description
Metadata
Metadata
Assignees
Labels
P1Significant semantic, completeness, correctness issues.Significant semantic, completeness, correctness issues.component: docsREADME, specifications, security, and contributor documentationREADME, specifications, security, and contributor documentationdiscovered-by-codexIssues discovered via review by codex.Issues discovered via review by codex.domain: distributionCrates.io, GitHub Releases, Homebrew, and installable artifactsCrates.io, GitHub Releases, Homebrew, and installable artifactsdomain: governanceProject policy, support, ownership, and release authorityProject policy, support, ownership, and release authoritydomain: usabilityCLI experience, diagnostics, installation, and contributor experienceCLI experience, diagnostics, installation, and contributor experienceepicOrganizing issue that tracks a coherent remediation workstreamOrganizing issue that tracks a coherent remediation workstreamproduction-readinessPart of the audited path from prototype to production-ready usePart of the audited path from prototype to production-ready userelease-blockerMust close before the production-readiness release gate can passMust close before the production-readiness release gate can passtarget: v0.2.0Must be resolved or explicitly waived before the v0.2 production auditMust be resolved or explicitly waived before the v0.2 production auditworkflow:production-readinessIncluded in automatic production-readiness work selectionIncluded in automatic production-readiness work selectionworkflow:production-readiness-gateEpic, audit, publication, or program gate requiring landed prerequisitesEpic, audit, publication, or program gate requiring landed prerequisites
Parent
#26
Objective
Make the supported behavior, security boundaries, release promise, and contributor/maintainer processes accurate and discoverable, then prepare practical distribution after the audited v0.2 release.
Why this blocks release
The README has a broken quickstart, incomplete installation and CLI contract, mutable/unlocked CI guidance, and stale preview language.
Specification.mdis historical but easy to mistake for a normative contract. The repository lacks CHANGELOG, SECURITY, and CONTRIBUTING documents, has one crate owner, and has no tags/releases or Homebrew distribution.Workstream order
Completion criteria
Relationships
Prior art
Draft PR #21 removes the historical specification and cleans part of the README. It is currently conflicting and predates the audit; leaf tickets must explicitly extract, supersede, or reconcile its changes.