Documentation Guides

Main pages & Sub-Pages #

Main pages #

Main pages are the main source of content in the documentation. They act both as a main section in the navigation and an introduction to sub-pages if necessary.

In the SUMMARY.md, they are actually main markdown links, with the format - [Title](source.md)

- [Main page](main.md)
- [Another main page](another.md)

Sub-pages #

Sub-pages are children of main-pages, usually some form of content-split around the same subject. They are also markdown links, but indented:

- [Subject](subject.md)
    - [Sub-page one about the subject](sub-page-1.md)
    - [Sub-page two about the subject](sub-page-2.md)

Sub-pages cannot exists with a page above them.