FsCDK Documentation Diagrams

This directory contains both the source Mermaid diagrams (.mmd files) and the generated SVG images (.svg files) used in the FsCDK documentation.

Generated SVG Files ✓

All 7 diagrams have been successfully converted to SVG format:

Total: 567 KB (7 files)

Source Files

All diagrams have corresponding .mmd source files that can be edited and regenerated:

• cognito-oauth-m2m-flow.mmd
• eventbridge-architecture.mmd
• step-functions-order-workflow.mmd
• lambda-production-defaults.mmd
• fscdk-architecture.mmd
• sns-sqs-messaging-patterns.mmd
• multi-tier-architecture.mmd

Editing Diagrams

To modify a diagram:

1. Edit the corresponding .mmd file
2. Run the conversion command: bash mmdc -i diagram-name.mmd -o diagram-name.svg
3. The updated SVG will be automatically used in the documentation

Regenerating All Diagrams

If you need to regenerate all SVG files:

Windows (PowerShell):

cd C:\git\FsCDK\docs
.\convert-mermaid-to-svg.ps1

Linux/Mac (Bash):

cd /path/to/FsCDK/docs
./convert-mermaid-to-svg.sh

Documentation References

These SVG files are referenced in the following documentation files:

Tools

• Mermaid CLI: Converts .mmd files to .svg
• Installation: npm install -g @mermaid-js/mermaid-cli
• Documentation: https://github.com/mermaid-js/mermaid-cli

Benefits of SVG Format

✅ Fast page load (no JavaScript rendering) ✅ Better SEO (search engines can index images) ✅ Works offline (no CDN dependency) ✅ Scalable (SVG is vector-based) ✅ Version control friendly ✅ Cross-browser compatible

Last Updated: 2025-11-19 Total Diagrams: 7 Status: ✅ All diagrams generated successfully