Add: high-level design doc with Mermaid diagrams - #794
Merged
Merged
Conversation
docs/HLD.md describes SpecSync 6.0.0 end to end: context, components, the check pipeline, the change lifecycle state machine, sequence diagrams for new/answer/approve, check --commit, review/finalize/ship and the CI + Trust PR path, the .specsync layout, evidence files and digests, build/release/distribution, trust boundaries, failure modes, decisions and a glossary. It links the existing docs instead of repeating them. README gains a short Architecture section with one overview diagram that links to the HLD. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01V3ZZAEiUP7xRJPozhZb6rL
0xLeif
requested review from
0xGaspar,
Kyntrin and
tofu-ux
and removed request for
a team
September 26, 2026 03:07
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
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
docs/HLD.md, a high-level design for SpecSync 6.0.0 with 10 Mermaid diagrams. It covers context, components, thecheckpipeline, the change lifecycle state machine, sequence diagrams fornew/answer/approve,check --commit,review/finalize/shipand the CI + Trust PR path, an ER diagram of the change evidence files, and the release flow..specsync/layout, the lifecycle digests and their domain tags, build and distribution, trust boundaries, failure modes, decisions, a glossary and a map of the existing docs. It links the existing docs rather than repeating them, and each claim cites the source file or function it comes from.docs/andREADME.mdare outsidemeaningful_pathsin.specsync/sdd.json, andchange audit --strictpasses with 0 active changes.corvidlabs.github.io/spec-syncis a redirect shell to the CorvidLabs hub, plus the atlas badges. The HLD is not published there; GitHub renders the Mermaid in the repo directly.Worth knowing while reviewing: section 4.4 of the HLD records that
change check --commitandchange ship --pushstage withgit add -A(git_commit_allinsrc/commands/change.rs). That stages untracked files anywhere in the tree. This PR only documents that behavior; it does not change it.Test Plan
@mermaid-js/mermaid-cli12.0.0docs/HLD.mdandREADME.mdresolvesfledge lanes run pre-pushpassesfledge lanes run verifypasses (2498 + 437 tests, clippy, release build, strict spec check at 100% coverage)specsync change audit --strictpasses (0 active changes)fledge trust verify --range origin/main...HEADpasses (Augur proceed, risk 27; provenance soft)hi checkpasses (159 criteria, 11 families)馃 Generated with Claude Code
https://claude.ai/code/session_01V3ZZAEiUP7xRJPozhZb6rL