docs: add Bash v1 mounted-chain architecture guide and spec pointer - #342
Closed
teseo wants to merge 2 commits into
Closed
docs: add Bash v1 mounted-chain architecture guide and spec pointer#342teseo wants to merge 2 commits into
teseo wants to merge 2 commits into
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
added 2 commits
July 28, 2026 07:17
…d-chain architecture guide and canonical specification pointer.
…cb-chain.sh entry point
teseo
force-pushed
the
combo/e2e-339-aa0efdf-r5-20260728
branch
from
July 28, 2026 06:21
563516b to
cd9f5f3
Compare
Contributor
Author
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.
Intent
Update Combo Chen docs, architecture, specifications, and guides to match the real Bash v1 chain while excluding README and all non-docs payloads.
What Changed
docs/bash-v1-chain.md, a comprehensive normative architecture, runtime specification, and operator guide for the Bash v1cb-plan.sh→cb-chain.shpipeline covering component ownership, the five execution endpoints, normalized exit classes, step routing, replay semantics, and operator commands.docs/spec.mdwith a forward pointer declaring the mounted-chain contract as the governing document for the Bash v1 product line where it differs from legacy v0 mechanics.cb-run.shreferences so all documented entry points match the realcb-chain.shstate machine.Testing
Verified the docs-only change by running the three most relevant test suites (chain state machine, plan contract, step adapter contract — 16/16 tests passed), then manually cross-referenced every documented script name, the architecture flow, exit codes, and step exit classes against the actual code. All 10 documented scripts exist, cb-run.sh (the prior finding) is correctly absent, and zero non-docs files were changed — meeting the user intent constraint exactly.
Evidence: Doc-to-code alignment evidence
Pipeline
Updates from git push no-mistakes
✅ **intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
⏭️ **Review** - skipped
Step was skipped.
🔧 **Test** - 1 issue found → auto-fixed ✅
docs/bash-v1-chain.md:18- docs/bash-v1-chain.md prominently documentscb-run.shas the central dispatcher/mounter (architecture diagram, component ownership table, endpoint job/receipt protocol §4, operator guide §11) butcb-run.shdoes not exist in the codebase. The actual state machine (cb-chain.sh) is invoked directly by tests without this intermediate layer. If the intent is forward-looking specification, this is acceptable; if the intent is to match current reality, the docs describe an unimplemented component.tests/run.shtests/chain-state-machine.test.shtests/plan-contract.test.shtests/step-adapter-contract.test.shtests/mechanical-ends.test.shtests/journal-spine.test.shManual plan compilation and step-order verification viacb-plan.shCross-reference verification between docs/spec.md and docs/bash-v1-chain.mdGit diff verification that only docs/ files changed🔧 Fix: Remove cb-run.sh references from docs, match real cb-chain.sh entry point
✅ Re-checked - no issues remain.
tests/run.shtests/chain-state-machine.test.sh (all 6 passed)tests/plan-contract.test.sh (all 5 passed)tests/step-adapter-contract.test.sh (all 5 passed)Manually verified all 10 documented scripts exist in bin/ and cb-run.sh is correctly absentManually verified architecture flow, exit codes, and step exit classes match between docs/bash-v1-chain.md and actual codeManually verified only docs/ files changed — no non-docs payloads touchedBaseline: tests/run.sh (pre-existing pass)⏭️ **Document** - skipped
Step was skipped.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.