Skip to content

Add living-spec workflow for solo product documentation - #4

Merged
Go7hic merged 1 commit into
mainfrom
agent/add-living-spec
Aug 9, 2026
Merged

Add living-spec workflow for solo product documentation#4
Go7hic merged 1 commit into
mainfrom
agent/add-living-spec

Conversation

@Go7hic

@Go7hic Go7hic commented Aug 9, 2026

Copy link
Copy Markdown
Owner

What changed

  • add a new living-spec skill with three operations:
    • inspect decides whether a change needs durable documentation and finds the repository's existing source of truth;
    • draft creates one lightweight change brief for multi-session or multi-PR work;
    • converge updates current product truth only after real-surface verification;
  • add portable templates for current product docs, temporary change briefs, and ADRs;
  • integrate the documentation persistence check and convergence gate into the Feature playbook;
  • expose living-spec from the pstack entry skill and document the solo-project workflow in README and COVERAGE;
  • protect the portable-only skill from upstream imports through UPSTREAM_MANIFEST.json.

Why

Solo developers often use pstack directly and still need a maintained description of what the product currently promises. Previously, pstack recorded design and execution evidence but did not explicitly converge verified product behavior into a durable current-truth document.

This change adds that missing layer without requiring OpenSpec or forcing documentation onto trivial edits and internal refactors.

Behavioral rules

  • reuse OpenSpec, an existing spec framework, ADR convention, or product-doc hierarchy when the repository already has one;
  • create documentation only for durable user-visible, operator-visible, API, security, billing, permission, retention, or business behavior;
  • keep current truth, temporary change context, ADR rationale, and execution evidence in separate artifacts;
  • update current truth from the final verified implementation, not from the initial plan;
  • report a convergence gap instead of rewriting intent to match broken code.

Validation

The repository's pull-request workflow will run:

  • mirror consistency checks;
  • full strict portability audit;
  • Markdown relative-link validation;
  • model override fixtures;
  • import idempotency checks.

Review focus

  • whether the persistence decision is light enough for solo projects;
  • whether Feature should invoke living-spec only for durable behavior changes;
  • whether the three templates capture enough context without recreating a full spec framework.

Introduce a lightweight current-product-truth skill, templates for product docs, change briefs and ADRs, and integrate documentation convergence into feature work.

Co-authored-by: ChatGPT <noreply@openai.com>
@Go7hic
Go7hic marked this pull request as ready for review August 9, 2026 13:29

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b206901995

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

2. `architect` for parallel design exploration. Skipping stays as `architect skipped: <reason>`; do not fold the design decision silently into implementation.
3. Write the throughput checkpoint as four todo items. A dimension that genuinely does not apply (single file, no fan-out) keeps its item with `n/a: <reason>` rather than being dropped:
1. Run **living-spec inspect** for documentation persistence.
- If the change does not alter durable user-visible or business behavior, keep the todo as `living-spec: not required — <reason>`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve non-user-facing persistence triggers

For features that change operator-visible, API, security, billing, permission, or retention behavior without being directly user-visible, this instruction permits not required, even though the persistence decision in skills/living-spec/SKILL.md explicitly includes all of those categories. Since agents copy the Feature playbook into their todo list, this narrower shortcut can skip the product-document update that the new workflow is intended to require; use the same complete trigger set here.

Useful? React with 👍 / 👎.

@@ -0,0 +1,35 @@
# ADR-<number>: <Decision title>

Status: proposed

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Mark ADRs created during convergence as accepted

When an ADR is created through living-spec converge, the implementation has already been verified and the durable decision has already been selected, but this template leaves the resulting record in proposed state. Because the workflow contains no later step that promotes the ADR, completed changes will retain an apparently unresolved decision; default this convergence-only template to an accepted status or explicitly require the status transition.

Useful? React with 👍 / 👎.

@Go7hic
Go7hic merged commit c97fdbb into main Aug 9, 2026
1 check passed
@Go7hic
Go7hic deleted the agent/add-living-spec branch August 9, 2026 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant