Versioning

Doctave supports publishing multiple versions of your documentation at the same time. Versions point to either a Git branch or a specific commit hash. All projects will have at least one version, and it by default follows the main branch. When you publish a new set of documentation in a branch, that version will update accordingly.

The visibility and access to each version can be configured individually. If you have more than 1 public version, your readers can toggle between the versions in your site.

The above picture also shows a private development version, which will only be visible to your team members, and won't be shown for regular readers.

Creating multiple versions of your docs

You will need two git branches. In this example, we will use main and dev.

Navigate to your project settings and see the versions sections.

By default there will be the version for main. Start creating a new version for dev by clicking on "New Version". Configure the version to follow the dev branch.

Once you have created the new version, all new updates in the dev branch will be found in this version. The published docs for this version can be found by appending your docs URL with the version's name, for example https://docs.example.com/dev.

Creating a private version

Start creating a new version and select the visibility to be private.

Only the members of your Doctave team can access private versions. Anyone else attempting to access the version will receive a 404 Not Found error. The private version will not be listed in the list of versions for readers outside your team.

Protecting your docs with a password

Start creating a new version and select the visibility to be protected.

When trying to access a password protected version, the reader will be redirected to a page prompting a password. If the password matches the password you have set, they will be given access to the version for 1 week after which they will have to re-enter the password.

Your team members will have access to all password protected versions without having to provide a password.