Desktop App Documentation

Table of Contents

• Building the Desktop Docs
• General Notes
• Generating the Documentation
• Target Branch and Backporting
• Branching Workflow
• Create a New Version Branch for the Desktop App

Building the Desktop Docs

The Desktop App 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.

General Notes

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.

Generating the Documentation

See the Generating the Documentation in the docs repo for more details as it applies to all documentation repositories.

Target Branch and Backporting

See the following section as the same rules and notes apply.

Branching Workflow

Please refer to the Branching Workflow for the Desktop App for more information.

Create a New Version Branch for the Desktop App

Please refer to Create a New Version Branch for the Desktop App for more information.