Skip to content

docs(graph): expand statum-graph usage guide#15

Merged
eboody merged 1 commit intomainfrom
docs/statum-graph-docs
Mar 25, 2026
Merged

docs(graph): expand statum-graph usage guide#15
eboody merged 1 commit intomainfrom
docs/statum-graph-docs

Conversation

@eboody
Copy link
Copy Markdown
Owner

@eboody eboody commented Mar 25, 2026

Summary

  • expand the statum-graph README with Mermaid output, graph traversal, entry-point guidance, and scope notes
  • document when to use MachineDoc::from_machine(...) versus MachineDoc::try_from_graph(...)
  • clarify Mermaid renderer guarantees in the Rust docs

Verification

  • cargo test -p statum-graph --offline
  • RUSTDOCFLAGS='-D warnings' cargo doc -p statum-graph --offline --no-deps

@eboody eboody merged commit 84eb713 into main Mar 25, 2026
7 checks passed
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