Skip to content

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

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

  • Add docs/HLD.md, a high-level design of fledge written from the code: command dispatch (including how unknown verbs become plugin commands), fledge.toml, task and lane execution, the plugin system (install, manifest, registry, fledge-v1 protocol, WASM sandbox), work, release and the GitHub plugin, hooks, data and file locations, deployment, the trust model, failure modes and limits, and the decisions in specs/*/context.md. Every section links to the source files it describes.
  • 14 Mermaid diagrams: context, module map, dispatch, sequence diagrams for fledge run, fledge lanes run, plugin install, plugin invocation, work plus the GitHub plugin, and release, plus hooks, the fledge.toml ER diagram, the plugin manifest and registry class diagram, the release pipeline and trust-tier classification.
  • README: a short Architecture section with one overview diagram and a link to the HLD. Nothing else in the README changed.
  • Pages is unchanged on purpose. The Astro site built by pages.yml is now redirect-only (every route goes to the CorvidLabs hub), so there is no docs page to add Mermaid to. The HLD is read on GitHub, which renders Mermaid natively.
  • hi/ and INTENT.md already exist and are untouched. hi check passes.

Things the HLD records as observed behavior, which may be worth a look separately (no code changed here):

  • A Swift repo with no fledge.toml is detected as swift, but auto_detect_tasks has no Swift entry, so fledge run lists no tasks.
  • If a post_remove hook fails, plugins remove has already deleted the command links but leaves the plugin dir and registry entry.
  • install.sh does not check the release .sha256 sidecar (the GitHub Action does).

Test Plan

  • All 14 HLD diagrams and the README diagram render with mmdc (mermaid-cli 12.0.0)
  • All 72 relative file links in docs/HLD.md resolve
  • hi check passes (197 criteria, 10 families)
  • fledge lanes run verify passes (fmt, lint, test, build, spec-check, validate-templates)
  • fledge trust verify --range origin/main..HEAD passes (verify-native lane, contract, risk proceed at 28, provenance soft)
  • specsync change check --strict --require-coverage 100 passes
  • CI green on this PR

🤖 Generated with Claude Code

https://claude.ai/code/session_01V3ZZAEiUP7xRJPozhZb6rL

docs/HLD.md explains how fledge works end to end, true to the code:
command dispatch, fledge.toml, task and lane execution, the plugin
system (install, manifest, registry, fledge-v1 protocol, WASM), work,
release and the GitHub plugin, hooks, data, deployment, trust model,
failure modes and decisions. 14 Mermaid diagrams, including sequence
diagrams for fledge run, fledge lanes run, and plugin install and
invocation. README gains a short Architecture section linking to it.

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 02:47
@0xLeif
0xLeif requested review from 0xGaspar, Kyntrin and tofu-ux and removed request for a team September 26, 2026 02:47
@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.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Corvin says...

      _
    <(^\  .oO(Caw! ^v^)
     |/(\
      \(\\
      " "\\

"Caw! Found a shiny new spec!"

CI Summary

Check Status
Dependency Audit ✅ Passed
Integration (3 OS) ✅ Passed
Lint (fmt + clippy) ✅ Passed
Spec Validation ✅ Passed
Tests (3 OS) ✅ Passed

Powered by corvid-pet

@0xLeif
0xLeif merged commit c65af7f into main Sep 26, 2026
22 checks passed
@0xLeif
0xLeif deleted the docs/hld-mermaid branch September 26, 2026 03:37
@0xLeif 0xLeif mentioned this pull request Sep 26, 2026
5 tasks done
0xLeif added a commit that referenced this pull request Sep 26, 2026
Rebasing onto main brought in four commits the section did not list:
#531, #533, #534 and #535. Add them where fledge's generator places
them.

Also drop the stale "## Unreleased" block. Both of its bullets describe
#520 (c4abcb2), which ships in 1.8.0, so they move under that entry as
sub-bullets instead of being advertised as unreleased. `fledge release`
inserts the new section above an existing Unreleased block rather than
consuming it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01V3ZZAEiUP7xRJPozhZb6rL
@0xLeif 0xLeif mentioned this pull request Sep 26, 2026
4 of 5 tasks
0xLeif added a commit that referenced this pull request Sep 30, 2026
fledge 1.8.0 was published to crates.io on 2026-09-19 from 435b7c5, a
release-branch head that never reached main. 1.8.1 is that release cut
from main, with #531, #533, #534 and #535 on top.

Bumps Cargo.toml and flake.nix to 1.8.1. Cargo.lock differs from the
published 1.8.0 lockfile only in fledge's own version; no dependency
moves. The bump was done by hand, because `fledge release` runs
`cargo generate-lockfile`, which re-resolves every dependency.

The changelog section covers every commit since v1.7.2, with a note on
1.8.0. The stale "Unreleased" block, which described #520 (shipped
here), is folded into that entry.


Claude-Session: https://claude.ai/code/session_01V3ZZAEiUP7xRJPozhZb6rL

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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