Skip to content

Add: high-level design doc with Mermaid diagrams - #794

Merged
0xLeif merged 1 commit into
mainfrom
docs/hld-mermaid
Sep 26, 2026
Merged

0xLeif merged 1 commit into
mainfrom
docs/hld-mermaid

Conversation

@0xLeif

@0xLeif 0xLeif commented Sep 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds docs/HLD.md, a high-level design for SpecSync 6.0.0 with 10 Mermaid diagrams. It covers 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, an ER diagram of the change evidence files, and the release flow.
  • Also covers the .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.
  • Adds a short Architecture section to the README with one overview diagram and a link to the HLD. The rest of the README is unchanged.
  • No SpecSync change package: docs/ and README.md are outside meaningful_paths in .specsync/sdd.json, and change audit --strict passes with 0 active changes.
  • Pages: nothing changed. corvidlabs.github.io/spec-sync is 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 --commit and change ship --push stage with git add -A (git_commit_all in src/commands/change.rs). That stages untracked files anywhere in the tree. This PR only documents that behavior; it does not change it.

Test Plan

  • All 10 HLD diagrams and the README diagram render with @mermaid-js/mermaid-cli 12.0.0
  • Every relative link and in-page anchor in docs/HLD.md and README.md resolves
  • fledge lanes run pre-push passes
  • fledge lanes run verify passes (2498 + 437 tests, clippy, release build, strict spec check at 100% coverage)
  • specsync change audit --strict passes (0 active changes)
  • fledge trust verify --range origin/main...HEAD passes (Augur proceed, risk 27; provenance soft)
  • hi check passes (159 criteria, 11 families)

馃 Generated with Claude Code

https://claude.ai/code/session_01V3ZZAEiUP7xRJPozhZb6rL

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
0xLeif requested a review from a team as a code owner September 26, 2026 03:07
@0xLeif
0xLeif requested review from 0xGaspar, Kyntrin and tofu-ux and removed request for a team September 26, 2026 03:07
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@0xLeif
0xLeif merged commit be3d90d into main Sep 26, 2026
22 checks passed
@0xLeif
0xLeif deleted the docs/hld-mermaid branch September 26, 2026 03:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant