The Desktop Client documentation is not built independently. Instead, it is built together with the main documentation. However, you can build a local copy of the desktop client documentation to preview changes you are making.
Whenever a Pull Request of this repo gets merged, it automatically triggers a full docs build.
To make life easier, most of the content written in docs applies also here. For ease of reading, the most important steps are documented here too. For more information see the link provided. Only a few topics of this repo are unique like the branching.
Refer to the Antora Site Structure for Docs for more information.
To prepare your local environment, some steps need to be made:
1.) Have the necessary prerequisites installed.
2.) Clone this repository and run
yarn install
to setup all necessary dependencies.
Run the following command to build the client documentation locally
yarn antora-local
Assuming that there are no build errors, the next thing to do is to view the result in your browser. In case you have already installed a web server to access local pages, you need to configure a virtual host (or similar) which points to the directory public/, located in the root directory of this repository. This directory contains the generated documentation. Alternatively, use the simple web server serve bundled with the current package.json, just execute the following command to serve the documentation at http://localhost:8080/desktop/:
yarn serve
See the following section as the same rules and notes apply.
Please refer to the Branching Workflow for the Desktop Client or more information.
Please refer to Create a New Version Branch for the Desktop Client for more information.