-
Notifications
You must be signed in to change notification settings - Fork 0
docs: create example output gallery in README #5
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Summary
The README explains what FlowMaster does but does not show real example outputs. A visual gallery of sample diagrams for different project types would help users understand FlowMaster'''s capabilities at a glance.
What needs to happen
- Generate example FlowMaster diagrams for 3-5 common project types:
- Next.js App Router project
- SvelteKit project
- Astro project
- Express.js API
- A simple multi-page app
- Add a "## Examples" or "## Gallery" section to
README.md - Include both the rendered Mermaid diagram (using GitHub'''s native Mermaid rendering in ```mermaid blocks) and a brief description of what each diagram shows
- Show both Analyze and Studio mode outputs if they differ
Acceptance criteria
- At least 3 example diagrams visible directly in the README on GitHub
- Each example includes: project type, brief description, rendered diagram
- Diagrams render correctly in GitHub'''s Mermaid preview
- Examples demonstrate different node types and layout patterns
Getting started
- Run FlowMaster against a small sample project (or create a minimal one)
- Capture the Mermaid output
- Add it to README.md inside a ```mermaid code block
- Verify it renders on GitHub
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers