Configuration

Workflow Creation

Set up your documentation workflow by configuring repositories, branches, and hosting options

Overview

After signing in, navigate to the Configuration tab on your dashboard to create a new documentation workflow. You'll need to select a repository to monitor, specify which branch to track, and choose how you want to host your documentation.

Select Repository

Start by selecting the repository you want to monitor for documentation generation. Click on the repository dropdown to see all available repositories from your connected GitHub account.

Step 1: Click on "Choose a repository"

Step 2: Select your repository from the dropdown

Select Branch

Choose which branch Docsalot should monitor for changes. Documentation will be automatically generated when pull requests are merged into this branch.

Select the branch to monitor

Choose Documentation Hosting

Docsalot offers two options for hosting your documentation:

Managed Documentation

We'll create and host your documentation with instant deployment and CDN. This is the simplest option with no setup required.

Bring Your Own Docs

Store documentation in your own GitHub repository with full control. Choose between the same repository or a different one.

Managed Documentation

With managed documentation, Docsalot handles everything for you. Simply select this option, and your documentation will be automatically generated, hosted, and deployed with each update.

Features

✓One-click documentation creation
✓Subdomain docs hosting (e.g., custom.docsalot.dev)
✓Auto docs sync with repository
✓Instant updates when your code changes

Preview your documentation URL

Bring Your Own Docs

If you prefer to store documentation in your own GitHub repository, you have two options:

Different Repository

Store documentation in a separate repository from your source code. This is useful when you want to keep documentation completely separate or have multiple source repositories contributing to one docs repository.

How it works

1.Select a different repository to store documentation
2.Docsalot will commit generated docs to this repository
3.Documentation updates automatically when code changes

Same Repository

Store documentation in the same repository as your source code. You'll need to specify a folder path where the documentation should be saved (e.g., docs or documentation).

How it works

1.Specify a folder path within your repository (e.g., docs)
2.Docsalot will commit documentation to this folder
3.Keep source code and docs in one place for easy maintenance

Note: When using "Bring Your Own Docs", make sure Docsalot has write access to the documentation repository.