Skip to content

docs: document crate organization and dependency graph#376

Open
heeckhau wants to merge 1 commit into
devfrom
docs/crate-organization
Open

docs: document crate organization and dependency graph#376
heeckhau wants to merge 1 commit into
devfrom
docs/crate-organization

Conversation

@heeckhau
Copy link
Copy Markdown
Collaborator

@heeckhau heeckhau commented Mar 6, 2026

Summary

  • Expands the Crates section in README.md to list all 25 workspace crates grouped by domain (Primitives, Foundation, Circuits, Protocols, Virtual Machine, Higher-level Protocols)
  • Explains the -core / high-level split pattern with a link to DESIGN.md
  • Adds a Mermaid dependency graph showing relationships between crates

Closes #268

Test plan

  • Verify Mermaid diagram renders correctly on GitHub
  • Confirm all crate links resolve to valid directories

Lists all workspace crates grouped by domain with descriptions,
explains the -core/high-level split pattern, and adds a Mermaid
dependency graph.

Closes #268
@heeckhau heeckhau force-pushed the docs/crate-organization branch from e105598 to f001d9a Compare March 9, 2026 12:02
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.

Document crate organization

1 participant