Documentation
README
SVG Diagramming Conventions
Output location and referencing
Diagrams go in SVG, never ASCII art. That rule decides whether to draw; this skill covers how, starting with where the file lands.
- Put the file in an
assets/directory next to the document (e.g.docs/foo.md→docs/assets/foo-arch.svg) - Reference it from markdown with a relative path,
. Do not inline SVG XML. - When data in the document changes, the corresponding SVG must be updated too. A figure that contradicts the prose beside it is worse than no figure
Core principles
This is the opening of the README. Read the full README on GitHub.