Skip to content

Align docs with flat graph API - #62

Merged
melonamin merged 1 commit into
masterfrom
agent/fix-flat-graph-docs
Aug 12, 2026
Merged

Align docs with flat graph API#62
melonamin merged 1 commit into
masterfrom
agent/fix-flat-graph-docs

Conversation

@melonamin

Copy link
Copy Markdown
Member

What changed

  • update Rust, TypeScript, WASM, root, and quickstart examples to the flat top-level graph API
  • replace removed request fields and per-statement node/edge access with current request fields and statement helpers
  • compile Rust README examples as crate doctests
  • add a TypeScript documentation contract that rejects the stale shapes during package typechecking

Why

Several first-party examples still used removed AnalyzeRequest fields and treated StatementMeta as if it owned graph collections. The runtime API has a flat result.nodes and result.edges graph.

Validation

  • cargo test -p flowscope-core --doc --locked
  • mise exec yarn@1.22.19 -- yarn workspace @pondpilot/flowscope-core typecheck
  • mise exec yarn@1.22.19 -- just check
  • Codex review: no actionable findings

@codecov

codecov Bot commented Aug 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@melonamin
melonamin marked this pull request as ready for review August 12, 2026 16:14
@melonamin
melonamin merged commit 9590147 into master Aug 12, 2026
9 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