Repository navigation
Add: docs/HLD.md, the high-level design, with its diagrams on Pages - #24
Merged
Merged
Conversation
docs/HLD.md describes how hi works end to end, from the code: argv routing, capture, retire and export as sequence diagrams, how HI/1 is parsed, the id rules, an id's standing as a state diagram, how the INTENT.md list is regenerated, the fledge plugin and its hooks, build and release, trust boundaries, and failure modes. Twelve Mermaid diagrams, all rendered with mermaid-cli before committing. The Pages site gains /architecture/: pages.yml converts the markdown with a pinned marked and splices it into docs/site/architecture.html, which draws the diagrams with Mermaid from jsdelivr. It is a separate page on purpose, because the hi view page fetches nothing (VIEW-2). The README gains a short Architecture section with one overview diagram and links to both. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01V3ZZAEiUP7xRJPozhZb6rL
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 written from the code: purpose, context, components, key flows, data, runtime and deployment, trust boundaries, failure modes, decisions and a glossary. It linksDECISIONS.mdandHI-1.mdrather than restating them, and marks what this repository cannot answer as Unknown: (the Homebrew tap and the corvidlabs.xyz docs site both live elsewhere).INTENT.mdfeature-list rewrite, howparse_bodyclassifies a line, a state diagram of an id's standing (not a lifecycle, per DECISIONS 搂5), the in-memory model, and build, release and Pages.pages.ymlnow also renders the HLD to/architecture/. It converts the markdown with a pinnedmarkedand splices it intodocs/site/architecture.html, which draws the diagrams with Mermaid from jsdelivr, fixes relative links to point at GitHub, and gives headings GitHub-style ids. It is a separate page on purpose: thehi viewintent page fetches nothing (VIEW-2), so Mermaid does not belong in hi's renderer, andindex.html,intent.htmlandintent.jsonare unchanged. The path filter addsdocs/HLD.mdanddocs/site/**.hi/changes.hi/already existed, so onlyhi checkwas run.Test Plan
fledge lanes run verifypasses (fmt, clippy, 229 tests, view-behaves 14 checks, intent, index, specsync 10/10, nudge-behaves, plugin validate)hi check: 168 criteria, 10 families, 7 files, 2 retired, no problems, no notesdocs/HLD.md(12) andREADME.md(1) renders withmmdc, with no syntax-error outputawksplice also under Ubuntu's mawk in Docker, byte-identical): 12 SVGs drawn in headless Chrome, no horizontal overflow at 375px or 1280px, and zero axe violations (WCAG 2.1 A/AA and best practice) in light and darkactionlintpasses onpages.yml馃 Generated with Claude Code
https://claude.ai/code/session_01V3ZZAEiUP7xRJPozhZb6rL