Skip to content

projectsyn/documentation

Project Syn Documentation

This is the umbrella documentation for Project Syn.

It is written using AsciiDoc and Antora. The source is located in the docs/ folder. The Divio documentation structure is used to organize its content.

Run the make preview command in the root of the project, and then browse to http://localhost:2020 to see a preview of the documentation.

After writing the documentation, please use the make check command and correct any warnings raised by the tool.

Contributing and license

This library is licensed under BSD-3-Clause. For information about how to contribute see CONTRIBUTING.