docs: bring README, guides and docs/ up to the phase-6e pipeline - #100
Merged
Conversation
The command table advertised 'ingest [-spec FILE] [-out DIR]' while the flagset's own usage says '-spec-root DIR -snapshot NAME'. The binary's help is the authority the CLI reference defers to, so the two strings must agree. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The rehearsal, static facts and the emit postcheck battery had no documentation at all; cli.md was missing three built commands and a dozen flags; the README still called specs a stub and phase 6 'next'; probing.md counted fifteen probes of sixteen. This brings every page up to the pipeline as it stands after five recorded waves, 23 blueprints and 22 live-green resources. - README: what/why, key features, updated architecture and layout, honest roadmap, quick start reduced to a pointer at the runbook, docs index - docs/cli.md: regenerated against the actual flagsets; specs/ingest/merge sections added; postcheck contract; behaviours-vs-subcommands trap - docs/fixtures-and-rehearsal.md (new): one fixture derivation, accFixture hints and omissions, plan promotion, the rehearsal fixpoint, new facts - docs/gates.md (new): every CI job, what it proves, local reproduction - docs/probing.md: sixteen probes, rehearsal, static facts, evidence freezing, proven-absence ledger resolution, deny gates experiments - docs/blueprint.md: rehearsal-era Behaviour fields, ConvertCall shape, updateExpand, literal args, accFixture/sweep/skipUnlessEnv, format - docs/architecture.md: current pipeline, package map, why the fixpoint lives in cmd - docs/generated-boundary.md: fixtures generated+policed, postcheck as the fifth enforcement, onboarding section deduplicated to the runbook - docs/onboarding-a-new-api.md: static facts, postcheck, rehearsal, promotion, gate list matched to the CI job names - pilot/thousandeyes/README.md (new): what the pilot proves, ownership, env gates, how to run it - SECURITY.md: replaced wrong-repo boilerplate with this repo's actual reporting channel and threat surface - CONTRIBUTING.md: postcheck expectation; removed a command that does not exist (probe redact --check) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
What
Documentation overhaul: every README and guide brought up to the pipeline as it stands after phase 6e (five recorded waves, 23 blueprints, 22 live-green resources), plus one one-line CLI fix so the docs' "the binary is right" rule holds.
Why
Three subsystems built during the probe-resequencing programme — the rehearsal, static facts and the emit postcheck battery — had zero mentions anywhere in README.md or docs/.
cli.mdhad no section for three built commands (specs,ingest,merge) and omitted ~12 flags. The README still calledspecsa stub and marked phase 6 "next".probing.mdcounted fifteen probes of sixteen. SECURITY.md was another repository's boilerplate.Changes
specs/ingest/mergesections added; postcheck contract; the rehearse.go/promote.go behaviours-not-subcommands trap namedaccFixturehints and omissions, plan promotion, the rehearsal fixpoint, the new fact kindsupdateExpand, literal args,accFixture/sweep/skipUnlessEnv,constraints.formatVerification
tfpluginframeworkgen <cmd> -houtput of the built binaryblueprint,scaffold); rehearsal/static-facts/postcheck now covered in every doc that should carry themgo build ./...and the root test suite green🤖 Generated with Claude Code