Skip to content

docs(authority): make final outputs canonical - #12

Merged
GentBajko merged 1 commit into
mainfrom
docs/final-output-authority
Sep 3, 2026
Merged

docs(authority): make final outputs canonical#12
GentBajko merged 1 commit into
mainfrom
docs/final-output-authority

Conversation

@GentBajko

@GentBajko GentBajko commented Sep 3, 2026

Copy link
Copy Markdown
Owner

Summary by Sourcery

Make formalized final outputs canonical and keep interview records as private working state throughout the documentation pipeline.

Enhancements:

  • Make formalized stage outputs the canonical, self-contained source of truth, with interview files retained only as local resume and repair state.
  • Update pipeline readback and downstream protocols to reconcile final outputs directly, relocate misplaced decisions, resolve contradictions, and record stable output-based ledger stamps.
  • Revise authoring, mapping, doctor, and craft guidance to remove interview/question provenance from final documentation while preserving decisions and rationale inline.
  • Align stage prerequisites, lifecycle handling, indexes, changelogs, and plugin metadata with the final-output authority model.

CI:

  • Add lint checks that prevent final-output guidance from exposing interview provenance.

Documentation:

  • Update user-facing pipeline and lifecycle documentation to describe final outputs as canonical and completed interviews as non-authoritative working state.

@sourcery-ai sourcery-ai 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.

Sorry @GentBajko, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 2 days and 4 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@GentBajko
GentBajko merged commit 900115c into main Sep 3, 2026
1 check passed
@GentBajko
GentBajko deleted the docs/final-output-authority branch September 3, 2026 22:17
@sourcery-ai

sourcery-ai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Reviewer's Guide

This PR makes formalized final documentation canonical and self-contained: downstream stages and readback consume final outputs, reconciliation edits owning files with stable stamp-based ledger tracking, interview provenance is removed and linted, stage protocols are updated accordingly, and plugin metadata versions are bumped.

Sequence diagram for final-output reconciliation

sequenceDiagram
    participant Start
    participant FinalOutputs
    participant User
    participant OwnerFile
    participant Ledger

    Start->>FinalOutputs: read formalized stage outputs
    FinalOutputs->>FinalOutputs: identify misplacement and contradictions
    FinalOutputs->>User: present re-file digest or finding
    User-->>FinalOutputs: confirm destination or resolution
    FinalOutputs->>OwnerFile: write decision and rationale
    FinalOutputs->>OwnerFile: remove or replace superseded rule
    OwnerFile->>Ledger: append stage readback entry
    FinalOutputs->>Ledger: write readback/all@stamp
    Ledger-->>Start: stable stamp enables unchanged-output skip
Loading

Flow diagram for stage lifecycle and canonical consumption

flowchart TD
    Working[Stage interview in progress]
    Formalize[Formalize stage]
    Final[Complete final output and changelog key]
    Consume[Later stage reads final output]
    Repair[Repair missing final content from completed interview]
    Unrecoverable[Report unrecoverable omission]

    Working --> Formalize
    Formalize --> Final
    Final --> Consume
    Final -->|missing or partial| Repair
    Repair --> Final
    Repair -->|working record unavailable| Unrecoverable
Loading

File-Level Changes

Change Details Files
Make formalized stage outputs the canonical, standalone source of truth instead of completed interview files.
  • Define lifecycle rules for reading unfinished interviews only for resume/repair, then consuming final outputs downstream.
  • Require final files to inline decisions and rationale without interview filenames or question-number citations.
  • Update stage protocols, authoring guidance, craft references, and lifecycle prerequisites to use formalized outputs.
  • Add doctor and map checks that detect and repair interview provenance in indexed final files.
skills/core/references/core-authoring.md
skills/core/references/core.md
skills/core/references/arch-craft.md
skills/core/references/uiux-craft.md
skills/core/references/topics.md
skills/core/references/protocols/architecture.md
skills/core/references/protocols/build.md
skills/core/references/protocols/doctor.md
skills/core/references/protocols/groom.md
skills/core/references/protocols/implement.md
skills/core/references/protocols/logic.md
skills/core/references/protocols/map.md
skills/core/references/protocols/mockup.md
skills/core/references/protocols/plan.md
skills/core/references/protocols/review.md
skills/core/references/protocols/stack.md
skills/core/references/protocols/standards.md
skills/core/references/protocols/uiux.md
skills/core/references/protocols/start.md
skills/core/scripts/lint-sync.sh
Rework the pre-build readback to reconcile canonical final files and apply changes directly to owning outputs.
  • Read six final stage outputs rather than interview bodies.
  • Re-file misplaced decisions and reconcile contradictions using final-file citations.
  • Update owning files, indexes, stamps, and changelog entries while leaving completed interviews unchanged.
  • Use a stable hash of latest stage changelog keys for readback skipping and reruns.
README.md
docs/commands.md
docs/flows.md
skills/core/references/protocols/start.md
skills/core/references/core.md
Align stage-specific output formats and prerequisites with standalone final references.
  • Remove interview provenance requirements from mockup, logic, UIUX, architecture, standards, stack, planning, and implementation documentation.
  • Inline confirmed decisions, rationale, open questions, and deferrals in final chapters and indexes.
  • Make downstream prerequisites depend on complete formalized outputs and their changelog keys.
  • Preserve design rationale inline when map refresh converts prescriptive references to observed facts.
skills/core/references/protocols/architecture.md
skills/core/references/protocols/build.md
skills/core/references/protocols/groom.md
skills/core/references/protocols/logic.md
skills/core/references/protocols/map.md
skills/core/references/protocols/mockup.md
skills/core/references/protocols/plan.md
skills/core/references/protocols/stack.md
skills/core/references/protocols/standards.md
skills/core/references/protocols/uiux.md
skills/core/references/topics.md
docs/flows.md
Update plugin metadata versions across supported integrations.
  • Bump the version metadata in the Claude marketplace and plugin manifests.
  • Bump the version metadata in the Codex, Cursor, Kimi, and Gemini integration manifests.
.claude-plugin/marketplace.json
.claude-plugin/plugin.json
.codex-plugin/plugin.json
.cursor-plugin/plugin.json
.kimi-plugin/plugin.json
gemini-extension.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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