Documentation resides in src\docs directory and its folder structure maps directly to Guidelines section of this styleguide.
The pages are authored in Github-flavoured Markdown and have .md extension accordingly. Twig can be also used for more complex documentation with variables parsing and control structures.
There are two statuses a documentation page can have, draft and ready, and are indicated by the red and blue dots, respectively, next to page’s name. By default, the status is set to draft. Once you’re ready with your page, add the following YAML front-matter snippet to the top:
---
status: ready
---By default the pages will be ordered alphabetically. Add two-digit number in front of of the name to enforce desired ordering.
If it makes sense to break down the documentation of particular project area in separate pages, create a folder and place them inside.
For more information on documentation pages, refer to Fractal’s help pages.