docs(authority): make final outputs canonical - #12
Merged
Conversation
There was a problem hiding this comment.
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.
Reviewer's GuideThis 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 reconciliationsequenceDiagram
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
Flow diagram for stage lifecycle and canonical consumptionflowchart 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
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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
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.
Summary by Sourcery
Make formalized final outputs canonical and keep interview records as private working state throughout the documentation pipeline.
Enhancements:
CI:
Documentation: