-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Add hidden recommended docs providers page in FAQ #163
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| title: Recommended Documentation Providers | ||
| --- | ||
|
|
||
| # Recommended Documentation Providers | ||
|
|
||
| Promptless works with all major documentation platforms. Here are the providers we recommend based on different team needs and use cases. | ||
|
|
||
| ## Popular Documentation Platforms | ||
|
|
||
| | Provider | Price Range | Example Promptless Customer | Best For | | ||
| |----------|-------------|-----------------------------|----------| | ||
| | Docusaurus | Free (open source) | [Temporal](https://docs.temporal.io/) | Teams with engineering resources that want rich customization | | ||
| | Fern | $400+/mo | [Vellum](https://docs.vellum.ai/) | Teams that want a premium offering with API-first support and interactivity | | ||
| | Mintlify | Free - $250+/month | [RunPod](https://docs.runpod.io/) | Startups and growing teams wanting modern, beautiful docs and quick setup | | ||
| | ReadMe | $79+/month | [Capillary Technologies](https://docs.capillarytech.com/) | API platforms prioritizing interactive developer experience without needs for previewing doc suggestions | | ||
| | GitBook | $77+/month | [Emporix](https://developer.emporix.io) | Simpler products without needs for previewing doc suggestions | | ||
|
|
||
| <Warning> | ||
| GitBook and ReadMe have technical limitations that prevent Promptless from generating live previews of documentation suggestions. You can still receive documentation updates with these providers, but you won't be able to preview changes before they're published. If live preview functionality is important for your team's review process, consider using Fern, Mintlify, or Docusaurus instead. | ||
| </Warning> | ||
|
|
||
| ## Finding the Right Provider for Your Team | ||
|
|
||
| When evaluating documentation platforms, the key factors to consider are: | ||
|
|
||
| - **Hosting**: Self-hosted (Docusaurus) vs. managed platforms | ||
| - **API documentation**: Auto-generation from OpenAPI specs vs. manual authoring | ||
| - **Collaboration**: Real-time editing features and user limits for your team size | ||
| - **Customization**: Complete control vs. pre-built themes | ||
| - **Budget**: Free open source vs. paid managed services | ||
| - **Developer experience**: Interactive API playground, code samples, and testing tools | ||
|
|
||
| <Tip> | ||
| Promptless works with all of these platforms. If you're using GitHub-synced docs (Fern, Mintlify, Docusaurus), Promptless can automatically create PRs with documentation updates. For hosted platforms like ReadMe and Zendesk, Promptless can publish updates directly. | ||
| </Tip> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.