api-docs-icon

Creating Documentation

In Sideko, a single Documentation Project maps one-to-one with a deployed documentation site. Within it you are able to write custom pages, generate API references, and customize it to be on-brand with your organization.

Creating a Documentation Project

Follow these steps to create a documentation project:

  1. Navigate to the Documentation tab
  2. Click + New
  3. Add your project title and click Create

Versioning

Documentation versioning is handled automatically in Sideko. When you first create your project v1 will be provisioned. As deploy your documentation to production, new versions will automatically be created so you have a clear history of how your documentation has evolved and what version is live at the present time.

Roles and Permissions

When you create a Documentation Project you will automatically be made a Project Admin in that project. All Organization Admins will automatically be assigned the Project Admin role as well. As a Project Admin you will be able to grant roles to other users in your organization.

See Project Roles & Permissions to learn more about each role and it's capabilities.