Skip to content

For the complete documentation index, see llms.txt.

Choose a platform

The right target docs platform is any Git-backed one that fits how your team works. Promptless supports any documentation platform as long as your content lives in a GitHub repository, so the decision comes down to your team’s needs rather than Promptless compatibility.

Promptless doesn’t require a specific platform — it requires that your content live as files in a GitHub repository it can open pull requests against. Any docs-as-code platform that builds from a Git-backed source works, whether that’s a static site generator you host yourself or a hosted docs tool that keeps its content in a repository. Some platforms aren’t natively Git-based but sync or mirror their content to GitHub, and those setups are fully supported too. Promptless only needs to reach the source through a repository.

For the platforms teams most often run on Promptless, see the supported platforms section of Doc locations & collections. If you’re not sure whether your platform is supported, contact help@gopromptless.ai. Support expands based on user feedback, and the team can help you choose and set up a docs platform.

Every supported platform works with Promptless, so weigh them on the factors that matter to your team:

  • Hosted docs tools vs. open-source generators. Hosted, docs-focused platforms like Mintlify, Fern, GitBook, and ReadMe pair a managed publishing experience with Git-backed content. Open-source static site generators like Starlight, Docusaurus, MkDocs, Hugo, Nextra, and Vocs give you full control over hosting and theming and no per-seat cost, at the price of owning the build and deploy yourself.
  • Content format. Most static site generators build from Markdown or MDX, though structured-authoring toolchains publish from their own source formats. If your team already authors in the target’s format, the migration is mostly moving files; if you’re coming from a WYSIWYG editor or a different source format, expect a conversion step (see Migrate to a new docs platform).
  • Authoring experience. If writers on your team don’t work in code, weigh how each platform handles day-to-day editing — raw Markdown in a repository, an in-app editor, or a Git-backed WYSIWYG. Hosted docs tools tend to offer a friendlier editing surface for non-engineer contributors, while open-source generators expect writers to edit Markdown and use the PR workflow directly.
  • Component and API-reference needs. If you rely heavily on interactive components or generated API references, favor a platform built for that — Fern, Mintlify, and Starlight, for example, have strong API-reference and MDX component support.
  • Existing toolchain. Teams already deploying on a given stack usually hit the least friction by staying close to it — a React/Astro shop lands naturally on Starlight, Docusaurus, or Nextra, while a Python team may prefer MkDocs.

Tip

You don’t have to decide alone. If you’re planning a migration, the Promptless team can help you pick a platform and set it up — reach out at help@gopromptless.ai.

Once you’ve chosen a platform and your content is in a GitHub repository, connect it as a doc collection so Promptless can start proposing updates. See Doc locations & collections for the setup steps and the promptless.yaml docs_framework field.