Choose a platform
Promptless works with any documentation platform whose content lives in a GitHub or GitLab repository. Pick a target platform by how well it fits your team. This page covers what Promptless needs from a platform and the factors to weigh when you choose one.
Use cases
Section titled “Use cases”Choosing a platform comes up in these situations:
- You’re moving off a hosted editor that keeps content in its own database. Pick a Git-backed target with the factors in How to choose, then follow Migrate to a new docs platform.
- Your current platform syncs or mirrors its content to GitHub. Check What Promptless supports first, because you might not need to move.
- Your writers don’t work in code. Compare the authoring experience of each platform so they can keep editing after the move.
What Promptless supports
Section titled “What Promptless supports”Promptless opens pull requests or merge requests on content that lives as files in a GitHub or GitLab repository. Any docs-as-code platform that builds from a Git-backed source works. That includes a static site generator you host yourself and a hosted docs tool that keeps its content in a repository. Platforms that aren’t natively Git-based but sync or mirror their content to GitHub work too, because Promptless reaches the source through the repository.
How to choose
Section titled “How to choose”Weigh the supported platforms on the factors that matter to your team:
| Factor | What to weigh |
|---|---|
| Hosting | Hosted docs tools, such as Mintlify, Fern, GitBook, and ReadMe, manage publishing for you. Open-source static site generators include Starlight, Docusaurus, MkDocs, Hugo, Nextra, and Vocs. They have no per-seat cost and give you full control of hosting and theming, and you own the build and deploy. |
| Content format | If your team already writes in the target’s source format, usually Markdown or MDX, the migration is mostly moving files. Coming from a WYSIWYG editor or another source format adds a conversion step. |
| Authoring experience | Hosted docs tools often offer an in-app or Git-backed WYSIWYG editor for writers who don’t work in code. Open-source generators expect writers to edit Markdown and open pull requests. |
| Components and API reference | If you rely on interactive components or generated API references, favor a platform built for them, such as Fern, Mintlify, or Starlight. |
| Existing toolchain | Staying close to the stack you already deploy on causes the least friction. For example, a React or Astro team fits Starlight, Docusaurus, or Nextra, and a Python team may prefer MkDocs. |
After you pick
Section titled “After you pick”Once your content is in a GitHub or GitLab repository, connect it as a doc collection so Promptless can start proposing updates. Set the collection’s Docs framework setting (docs_framework in promptless.yaml) to your platform. For the setup steps, see GitHub repos or GitLab projects.