📝 docs(examples): EX-S09 walkthrough byte-pinned to complex cases - #65
Merged
Conversation
… output (EX-S09) Step 3's console block was 8 lines of stale topic-registry-only output and the intro implied partitions was the sole governed field. Replace it with real, captured `assent test` output across all three shipped packs (YAML nested maps, JSON nested objects, tfvars nested maps, plus the .tf opaque and C8 companion-delete REVIEW cases), and name the REF-EX C1-C8 patterns by real case name. Extend hack/docs/truthlag_pins_test.sh (REQ-EX-S09-01..03) so every case name the walkthrough shows must exist in real assent test output, all four formats must be named, and any HCL/.tf claim must stay REVIEW/opaque/ known-limitation, never an "understands Terraform" overclaim.
…apshot Three follow-up fixes on the walkthrough pinning work: (1) the intro's "one YAML file" snippet showed invented fields (name/retentionMs) that exist nowhere in the shipped corpus - replace it with a trimmed excerpt of a real fixture; (2) Step 1's rule-file parenthetical still named the pre-S06 four-rule pack while the pack now ships nine, and add a filesystem-driven pin so that list can't go stale again; (3) the .tf/REVIEW honesty pin in truthlag_pins_test.sh grepped the whole page for "REVIEW|opaque", which can never fail once Step 3's console blocks exist (~30 REVIEW lines) - replace it with a stable-substring match on the actual honest sentence, reconfirmed by mutation to now redden when the sentence is softened. Also regenerate CHANGELOG.md (drift from the prior EX-S09 commit).
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.
Summary
docs/usage/walkthrough.mdStep 3 to show real, byte-capturedassent testconsole output from all three example packs (topic-registry YAML nested fields, service-catalog JSON nested objects, infra-vars tfvars nested maps), naming the.tfopaque-REVIEW and companion-file-delete-REVIEW (C8) cases by their real case names.openspec/specs/backlog.md's authoritative table.hack/docs/truthlag_pins_test.sh(not forked) with pins that compare fullname (DECISION)pairs bidirectionally between the walkthrough's console blocks and liveassent testoutput, so any invented case, wrong decision, or silently-truncated block reddens the gate. This closes a P1 found in round 1 of independent review (pins previously checked case names but not decisions).examples/README.mdwas checked and confirmed already accurate from prior lanes (S01/S05/S06/S07); left untouched.Spec:
openspec/specs/p5-ex-complex-examples/spec.mdEX-S09. Independently reviewed across two rounds — verdict APPROVE (round 1 P1 fixed and confirmed to genuinely generalize in round 2; only non-blocking P3 notes remain).Test plan
task checkgreen, includingchangelog-verifytask docs-gatesgreen (readme_smoke_test.sh,truthlag_pins_test.sh,example_format_inventory_test.sh)./bin/assentand re-ranassent testagainst all three packs (topic-registry, service-catalog, infra-vars); output matchesdocs/usage/walkthrough.mdStep 3 verbatimorigin/mainwas a no-op (lane already based on current tip)