Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0xLeif merged 1 commit into from
Sep 26, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,25 @@ specs/auth/

[Read the complete spec format](site/src/content/docs/spec-format.md), [companion-file reference](site/src/content/docs/companion-files.md), and [workflow conventions](site/src/content/docs/workflow.md).

## Architecture

One local binary does the work. Editors, the GitHub Action, MCP clients and agent skills all run
the same CLI. `check` is the drift check. `change` is the opt-in lifecycle that leaves its
evidence in Git.

```mermaid
flowchart LR
users([Developers, coding agents,<br/>VS Code, MCP clients, CI]) --> cli[[specsync]]
cli --> check[check<br/>spec vs code drift]
cli --> change[change<br/>new, approve, check,<br/>review, finalize]
check --> repo[(specs/ + source)]
change -->|scoped sync| check
change --> evidence[(.specsync/changes/<br/>then archive/)]
```

The [high-level design](docs/HLD.md) covers the components, the change state machine, sequence
diagrams for the key commands, the evidence files and digests, and CI, Trust and release.

## Documentation

| Start here | Reference and integration |
Expand Down
Loading
Loading