Skip to content

docs

update docs - Scan docs for mermaid diagrams and drawio images, update cache

Scans all files in docs/ for mermaid code blocks and drawio.png images, renders any missing mermaid diagrams to SVG and optimizes drawio images, updating the cache at docs/assets/cache/. Cached assets are tracked in git for faster CI builds and consistent rendering.

Flags

Flag Description
--dry-run (default: false) Show what would be updated without actually updating
--force (default: false) Force re-render/re-optimize all assets even if cached
-v, --verbose (default: false) Show detailed progress for each file

Notes

Expected Output:

  • SVG files in docs/assets/cache/ for mermaid diagrams
  • Optimized drawio images in docs/assets/cache/
  • Cache status summary showing hits/misses

See Also


Tutorials | How-to Guides | Explanation | Reference

You are here: Reference — information-oriented technical descriptions of the system.