Skip to content

Conversation

@jeremyeder
Copy link
Collaborator

Summary

  • Add 5 Mermaid diagrams replacing ASCII art visualizations
  • Enhance validate-mermaid.sh to extract and validate inline diagrams from markdown files
  • Fix malformed code block endings in docs/architecture.md

Diagrams Added

Location Diagram Type
docs/architecture.md Layered Architecture flowchart
docs/architecture.md Data Flow: Create Item sequence
docs/architecture.md Test Pyramid flowchart
docs/quickstart.md Getting Started Flow flowchart
.claude/agents/codebase-agent.md CBA Workflow flowchart

Validation Enhancement

The updated validate-mermaid.sh now:

  • Extracts inline ```mermaid blocks from all markdown files
  • Validates each diagram using mmdc (mermaid-cli)
  • Reports file path and line number for any errors
  • Falls back to basic syntax checking if mmdc is not installed

Test Plan

  • All 9 diagrams pass ./scripts/validate-mermaid.sh
  • Markdown linting passes
  • Diagrams render correctly on GitHub (verify after PR creation)

Add 5 Mermaid diagrams replacing ASCII art:
- Layered Architecture (docs/architecture.md)
- Data Flow sequence diagram (docs/architecture.md)
- Test Pyramid (docs/architecture.md)
- Getting Started Flow (docs/quickstart.md)
- CBA Workflow (codebase-agent.md)

Also:
- Fix malformed code block endings in architecture.md
- Enhance validate-mermaid.sh to extract and validate inline
  diagrams from markdown files (not just standalone .mmd)
Replace ((var++)) with var=$((var + 1)) to avoid exit code 1
when incrementing from 0 with set -e enabled.
Add puppeteer-config.json with --no-sandbox for GitHub Actions.
Update validate-mermaid.sh to use config when available.
@jeremyeder jeremyeder merged commit 4743b5c into main Jan 4, 2026
4 checks passed
@jeremyeder jeremyeder deleted the feature/concept-diagrams branch January 4, 2026 08:13
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.

2 participants