Solo supports docs-as-code platforms, allowing you to manage your help center directly from your codebase. By connecting your repository, Solo can automatically write, update, and manage your documentation via Pull Requests, saving your team time while keeping your articles organized in your version control system.
What are docs-as-code platforms?
Docs-as-code platforms are documentation tools that rely on a codebase—such as GitHub or GitLab—to store and manage your help articles. Popular tools that sit on top of these codebases include GitHub Docs, Mintlify, Astro Starlight, and Blume.
Solo fully supports these platforms, allowing you to keep your documentation workflows seamlessly tied to your existing version control system.
How Solo manages docs-as-code?
Solo manages your docs-as-code workflow entirely through a write-to-GitHub integration. When you approve documentation changes or generate new articles in Solo, the system pushes those updates directly to your connected GitHub repository.
This is the only scenario where Solo writes directly to GitHub. It ensures your repository remains the single source of truth for your documentation without requiring manual copying and pasting.
How PRs work for docs-as-code platforms?
When you accept a documentation suggestion or create a new article in Solo, the system automatically creates a new branch in your repository and opens a Pull Request (PR) for your team to review.
If there is already an open PR for a specific article, Solo updates that existing branch with your new changes instead of creating a duplicate PR. You can also accept multiple suggestions at once, and Solo will group those file updates into a single PR for streamlined reviewing.
How to connect docs-as-code to Solo
Go to Settings and select the Integrations tab.
Select the Documentation filter at the top to narrow down the list.
Locate the Github Documentation (Not for code) integration.
Select Connect. You will be redirected to GitHub to authorize and install the integration for your documentation repository.