Repository navigation
[PROOF-P1-S3] Write the document contract - #31
Merged
Merged
Conversation
…ysis, and a note skills/doc-artifact is the one contract for what /ck:proof writes from a request. Every kind opens with In one sentence and Decisions for you, and ends with Open questions and What I read. Between them a proposal has Why, What changes, Not doing, What could go wrong, and How we will know it worked; an analysis has The question, Findings, and What it means; a note has The note. A table sets the three kinds side by side: what each is for, what the author does with it, and its size in words. It says which kind a request is, and that a plan is none of them and goes to /ck:plan. The top of the file carries the status in the staged plan's own words, draft or approved. Three sample documents were written to the contract and rendered as proofs. At phone width a file path pushed Done when out of sight in a proposal's table of changes, so Where is its last column. tests/pending/P1-S3.sh moves to tests/checks/. Its five checks are as they were, and eight are added, each for a contract the five pass and that would still be wrong. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
d6veteran
marked this pull request as ready for review
October 13, 2026 00:43
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.
Stage P1-S3 of the staged plan
docs/plan/2026-10-12-any-document-as-a-proof.md: the one contract for a proposal, an analysis, and a note. It addsskills/doc-artifact/SKILL.mdand changes nothing outside the stage's three paths.What the contract fixes
Every kind opens with
In one sentenceand thenDecisions for you, and ends withOpen questionsand thenWhat I read. Only the sections between are the kind's own./ck:plan.# <Kind>: <subject>, thenDate: <YYYY-MM-DD>. Status: draft, not approved.These are the staged plan's own words, so one line says draft orapproved <YYYY-MM-DD>in both.Open: D1, D3.orNone open.Then a table,| # | Decision | Choices | Decided |, with the recommended choice first. A decided row stays.Seen:,Read:, orInferred:.Not checked:, so every document says where its evidence stops.Choices made here
The proposal fixes the opening and the ending and leaves the rest to this stage. Each of these is a line or two of the contract, so a comment here is enough to change one before the merge.
The stepsandFilesare one table,What changes, with a Where column.Whyis new: a document that is committed should say what is wrong today without the conversation that led to it.Appendix.is dropped from the last heading.## What I readso that a long list of sources costs nothing. The approved proposal for this work is 2,018 words by that count, at the edge. The author can ask for more.Looked at as a page
I wrote one sample document of each kind to the contract, in a scratch folder, rendered each with
scripts/render-proof.py, and looked at them at 1280 by 900 and at 375 by 812.###entry has 217 of them at 13 pixels: about 33 characters. The contract says 32 or fewer keeps to one line. The longest##heading it fixes is 26.Checks
tests/pending/P1-S3.shmoved totests/checks/P1-S3.sh. Its five checks are as stage P0-S1 wrote them. Only the two lines that start the program changed: it is passed the renderer and a scratch folder, and it imports two more modules.wc -w; the pathdocs/<kind>/<date>-<slug>.md; a plan is none of the kinds and/ck:planis named; and a document under each list's headings goes through the renderer and comes out with each heading once in the page's list of contents, in order, with a place of its own.bash tests/run.sh: 509 passed, 0 failed, 49 waiting in 4 files. Before the stage: 495 passed, 54 waiting in 5 files. The 14 new passes are this stage's thirteen and the house-style check that reads every contract. Ruff is clean, and the zsh checks ran.Notes for the reviewer and for later stages
README.mdsays "the ten document contracts". There were twelve folders before this stage and there are thirteen now. The README is that stage's file, so I left it.The steps,Files, andAppendix. What I read.brief-artifactandmemo-artifacthave one and are refused by PyYAML, though Claude Code reads them. I did not touch them.origin/mainat169363c.🤖 Generated with Claude Code