Documentation Organization

Last modified by Vincent Massol on 2026/03/10 17:45

Explanation

The Documentation feature is opiniated! After verifying that you match the requirements, you need to follow some rules to use it in your own wiki:

  • You need to have a top level page, for example Documentation, under which all the documentation pages for all products are placed.
  • Under the top level page, you should have a page per product. For example: XS, Cristal, Extensions. This is important as several features need to identify the product being documented and this is how it's identified (the page under the top level documentation page). For example, a feature requiring to know the product is the Documentation Navigation panel, which displays a navigation per product.
  • Then under the product page, you'll have the landing pages for each user target: User, Admin and Dev. Note that you don't need to have them all and you could very well only have a User page.
  • Then under the target pages, you can have the hierarchy you wish. An example is to have pages for each topic and then under each topic sub pages for sub topics, etc.

Visually this means the following page hierarchy:

<documentation page name, e.g. Documentation>
  |_ <product1 name, e.g. XS>
    |_ User
      |_ <topic1 name, e.g. Authentication>
        |_ <subtopic1 name>
          |_ ...
    |_ Admin
    |_ Dev
  |_ <product2 name, e.g. Cristal>
    |_ User
    |_ Admin
    |_ Dev
  |_ ...

Get Connected