Skip to content

docs: replace basic example with comprehensive real-world examples#9

Merged
brndnmtthws merged 1 commit intomainfrom
brndnmtthws/better-doc-examples
Jul 9, 2025
Merged

docs: replace basic example with comprehensive real-world examples#9
brndnmtthws merged 1 commit intomainfrom
brndnmtthws/better-doc-examples

Conversation

@brndnmtthws
Copy link
Collaborator

  • Add complete workflow example showing workspace discovery, graph building, cycle detection, and report generation
  • Include visualization example demonstrating Mermaid and DOT output generation
  • Add filtering example for production-only dependency analysis
  • Include targeted analysis example for finding cycles in specific workspaces
  • Fix import paths for ConfigBuilder to use common module
  • Use proper API patterns (graph_builder.graph() instead of returning graph)
  • Add proper error handling with miette::IntoDiagnostic
  • Make all examples use realistic monorepo scenarios

- Add complete workflow example showing workspace discovery, graph building, cycle detection, and report generation
- Include visualization example demonstrating Mermaid and DOT output generation
- Add filtering example for production-only dependency analysis
- Include targeted analysis example for finding cycles in specific workspaces
- Fix import paths for ConfigBuilder to use common module
- Use proper API patterns (graph_builder.graph() instead of returning graph)
- Add proper error handling with miette::IntoDiagnostic
- Make all examples use realistic monorepo scenarios
@brndnmtthws brndnmtthws merged commit 4e3847c into main Jul 9, 2025
15 checks passed
@brndnmtthws brndnmtthws deleted the brndnmtthws/better-doc-examples branch July 9, 2025 21:47
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