github.com/simpleiot/simpleiot@v0.18.3/docs/ref/documentation.md (about)

     1  # Documentation
     2  
     3  Good documentation is critical for any project and to get good documentation,
     4  the process to create it must be as frictionless as possible. With this in mind,
     5  we've structured SIOT documentation as follows:
     6  
     7  - Markdown is the primary source format.
     8  - documentation lives in the same repo as the source code. When you update the
     9    code, update the documentation at the same time.
    10  - documentation is easily viewable in Github, or our
    11    [generated docs site](https://docs.simpleiot.org/). This allows any snapshot
    12    of SIOT to contain a viewable snapshot of the documentation for that revision.
    13  - mdbook is used to generate the documentation site.
    14  - all diagrams are stored in a
    15    [single draw.io](https://github.com/simpleiot/simpleiot/blob/master/docs/diagrams.drawio)
    16    file. This allows you to easily see what diagrams are available and easily
    17    copy pieces from existing diagrams to make new ones. Then generate a PNG for
    18    the diagram in the `images/` directory in the relevant documentation
    19    directory.