File: writing-docs.md

package info (click to toggle)
golang-github-anacrolix-fuse 0.3.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,000 kB
  • sloc: makefile: 5; sh: 3
file content (16 lines) | stat: -rw-r--r-- 514 bytes parent folder | download | duplicates (6) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
# Writing documentation

## Sequence diagrams

The sequence diagrams are generated with `seqdiag`:
http://blockdiag.com/en/seqdiag/index.html

An easy way to work on them is to automatically update the generated
files with https://github.com/cespare/reflex :

    reflex -g 'doc/[^.]*.seq' -- seqdiag -T svg -o '{}.svg' '{}' &

    reflex -g 'doc/[^.]*.seq' -- seqdiag -T png -o '{}.png' '{}' &

The markdown files refer to PNG images because of Github limitations,
but the SVG is generally more pleasant to view.