Skip to content

Docs | Add an anatomy of craft and split out developer docs - #6

Merged
shahen94 merged 11 commits into
mainfrom
docs/anatomy
Oct 29, 2026
Merged

shahen94 merged 11 commits into
mainfrom
docs/anatomy

Conversation

@shahen94

@shahen94 shahen94 commented Oct 29, 2026 •

Copy link
Copy Markdown
Member

What

  • New Anatomy page: how craft works inside (CLI → manager → actors → pipes → services), an install end to end, resolution, metadata, the store and concurrency, why it's fast, and where it's still slow.
  • Mermaid diagrams, rendered client-side and lazy-loaded, themed for light and dark:
    ```mermaid
    flowchart LR
      a --> b
    ```
  • Docs split by audience: Guide, CLI and Benchmarks for users; a new Developers section (/developers/) holds Anatomy, Architecture, Getting set up and Testing.

Reviewer notes

  • /contributing/* URLs are gone (moved to /developers/*); VitePress has no redirects, so outside links to them will 404. The README link is updated.

Lets docs pages draw diagrams from mermaid code blocks.
Resolved by craft add, so craft ci in the docs workflow matches package.json.
Mermaid loads lazily, only on pages that have a diagram, and redraws in the site's colours whenever the theme switches between light and dark.
Makes MermaidDiagram available to every markdown page.
Contributor pages now live under /developers/, apart from the guide for people using craft.
Contributor pages now live under /developers/, apart from the guide for people using craft.
Contributor pages now live under /developers/, apart from the guide for people using craft.
Walks through the CLI, the manager, actors and pipes, an install end to end, resolution, metadata, the store and concurrency, with diagrams, to explain why craft is fast and where it is still slow.
Turns mermaid code blocks into diagrams, and replaces the Contributing nav with Developers, whose sidebar holds Anatomy and Architecture next to the contributing pages.
Readers who want the internals behind the layout can follow on to the developer docs.
The contributing pages moved to /developers/.
@shahen94
shahen94 merged commit d9cc580 into main Oct 29, 2026
6 checks passed
@shahen94
shahen94 deleted the docs/anatomy branch October 29, 2026 09:09
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