Skip to content

Commit 3e39f51

Browse files
committed
Update docs developer guides to explain rendering diagrams
1 parent c575e44 commit 3e39f51

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,8 @@ Quick links to system guides and diagrams. Each topic includes a process write
4444
- Production: [Production](./production)
4545
- Development: [Development](./development)
4646
- Polymorphism / STI: [Polymorphic and STI](./polymorphic_and_sti.md)
47+
48+
## Rendering Diagrams
49+
- Render only changed diagrams: `bin/render_diagrams`
50+
- Force re-render all: `bin/render_diagrams --force` (or `FORCE=1 bin/render_diagrams`)
51+
- CI fails if any diagram fails to render; see listed failed files in output.

0 commit comments

Comments
 (0)