Getting Started
GitHub App Installation
Install the Docsalot GitHub App to connect your repositories and start generating documentation
Overview
Before you can create documentation workflows, you need to install the Docsalot GitHub App. This gives Docsalot permission to access your repositories and automatically generate documentation when code changes.
The installation process involves three simple steps: authenticating with GitHub, installing the app, and configuring repository access.
Installation Steps
Step 1: Navigate to App Installation
After signing in to Docsalot, you'll see the setup progress at the top of your dashboard. Click on "Install App" to connect your GitHub repositories.
Step 2: Authorize on GitHub
You'll be redirected to GitHub where you can review the permissions that Docsalot requests. After signing in, you'll proceed to the configuration step.
Repository Access
You can choose to give Docsalot access to all your repositories or select specific ones. This setting can be changed later from your GitHub settings.
All Repositories
Select this option to give Docsalot access to all current and future repositories owned by your account. This includes public repositories as well as private ones you have access to.
Recommended if: You want to generate documentation for multiple repositories without having to manually grant access each time.
Only Select Repositories
Choose specific repositories that Docsalot can access. You can select multiple repositories and add more later from your GitHub settings.
Recommended if: You want fine-grained control over which repositories Docsalot can access, or if you're testing the service with a specific project.
After Installation
Once you've completed the installation, you'll be able to see your repositories in the configuration dropdown on your dashboard.
Troubleshooting
Repository Not Visible in Dropdown
If you don't see a repository you expect to see in the configuration dropdown, check the following:
- 1.Verify that the Docsalot GitHub App has access to that repository
- 2.Go to your GitHub Settings → Applications → Installed GitHub Apps → Docsalot
- 3.Click "Configure" and add the missing repository to the access list
- 4.Refresh your Docsalot dashboard to see the updated repository list
Permission Issues
If you encounter permission errors when creating workflows:
- •Make sure you have admin access to the repository you're trying to configure
- •For organization repositories, ensure your organization allows third-party app access
- •Check that the Docsalot app has the necessary permissions (read/write access to code and pull requests)
Reinstalling the App
If you need to reinstall the Docsalot GitHub App, you can uninstall it from your GitHub settings and then go through the installation process again from your Docsalot dashboard.
Note: Changes to repository access settings may take a few moments to propagate. If you don't see changes immediately, try refreshing the page after a minute.