Docsalot
Back to Home

Getting Started

Quickstart Guide

Get started with Docsalot in minutes and automate your documentation workflow

What is Docsalot?

Docsalot is an AI-powered documentation platform that automatically generates and maintains documentation for your codebase. It integrates seamlessly with your GitHub repositories and updates documentation whenever you merge pull requests.

Key Features

  • ✓Automatic documentation generation from code changes
  • ✓AI-powered 404 page recommendations for better user experience
  • ✓Instant deployment with CDN hosting or bring your own repository
  • ✓Customizable documentation with .docsalot.yaml configuration

Prerequisites

Before getting started with Docsalot, make sure you have:

  • •A GitHub account with access to the repositories you want to document
  • •Admin permissions on the repositories (required to install the GitHub App)
  • •A Docsalot account (sign up at docsalot.com)

Setup Steps

Follow these steps to set up Docsalot for your project:

1

Sign in with GitHub

Visit docsalot.com and click "Sign in with GitHub" to authenticate your account.

2

Install the GitHub App

After signing in, click on "Install App" in your dashboard. You'll be redirected to GitHub where you can choose to give Docsalot access to all repositories or select specific ones.

Learn more about GitHub App installation →
3

Create a Documentation Workflow

Navigate to the Configuration tab and create your first documentation workflow:

  • a.Select the repository you want to document
  • b.Choose the branch to monitor (usually main or master)
  • c.Select your hosting option: Managed Docs or Bring Your Own Docs
Learn more about workflow creation →
4

Configure Documentation (Optional)

Create a .docsalot.yaml file in your repository root to customize which files should be excluded from documentation.

# .docsalot.yaml
ignore:
  - "node_modules/"
  - "*.test.js"
  - "dist/"

ignoreFolders:
  - ".git/"
  - "coverage/"

ignoreFiles:
  - ".env"
  - "package-lock.json"
Learn more about .docsalot.yaml configuration →
5

Start Creating Documentation

That's it! Your documentation will now be automatically generated whenever you merge pull requests into your monitored branch. Docsalot will analyze your code changes and update the documentation accordingly.

✓ You're all set! Docsalot will now monitor your repository and generate documentation automatically. You can view your documentation at the URL provided in your workflow settings.

Next Steps

Now that you have Docsalot set up, here are some things you can do:

Customize Your Documentation

Fine-tune which files are included in your documentation by configuring your .docsalot.yaml file.

Read the configuration guide →

Set Up Additional Repositories

You can create documentation workflows for multiple repositories. Each repository can have its own configuration and hosting setup.

Create another workflow →

Explore Integrations

Connect Docsalot with your other tools and services to enhance your documentation workflow.

View integrations →

Need help? If you run into any issues, check out our detailed documentation pages or reach out to our support team.