-
Notifications
You must be signed in to change notification settings - Fork 3
docs: Move to docs-as-code only platform support #253
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
Open
promptless
wants to merge
2
commits into
main
Choose a base branch
from
promptless/docs-as-code-only
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 |
|---|---|---|
|
|
@@ -2,15 +2,15 @@ | |
| title: Doc Collections | ||
| --- | ||
|
|
||
| Doc Collections are the platforms where your documentation lives. Whether you're using Git-synced platforms such as Fern, Mintlify, or Docusaurus, or standalone platforms such as Zendesk and Intercom, you'll need to configure Promptless to read from and publish to your existing docs. | ||
| Doc Collections are the Git repositories where your documentation lives. Promptless supports docs-as-code workflows where your documentation content is stored in Git and synced to hosting providers. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Citation: Per @prithvi's request to move to docs-as-code only, removed Zendesk and Intercom as publishing destinations and refocused documentation on Git-hosted platforms. |
||
|
|
||
| ## Git-hosted Documentation Platforms | ||
| ## Supported Platforms | ||
|
|
||
| The most common setup uses GitHub repositories to store documentation content that syncs to hosting providers. A list of platforms supported through GitHub integration: | ||
| Promptless works with any Git-hosted documentation platform: | ||
|
|
||
| - Fern | ||
| - Mintlify | ||
| - ReadMe (Refactored) | ||
| - ReadMe | ||
| - GitBook | ||
| - Docusaurus | ||
| - MkDocs | ||
|
|
@@ -20,30 +20,16 @@ The most common setup uses GitHub repositories to store documentation content th | |
| - Vocs | ||
| - Custom platforms as long as the content is in a repo | ||
|
|
||
| Learn more: [GitHub Repos (Docs as Code)](/docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code) | ||
|
|
||
| ## Direct Platform Integrations | ||
|
|
||
| For teams using content management systems that don't sync with GitHub, Promptless offers direct integrations with popular platforms. | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Zendesk" icon="fa-solid fa-ticket" href="/docs/configuring-promptless/doc-collections/zendesk"> | ||
| Help center articles and knowledge base content management | ||
| </Card> | ||
|
|
||
| <Card title="Intercom" icon="fa-solid fa-comments" href="/docs/configuring-promptless/doc-collections/intercom-beta"> | ||
| Customer support documentation and help center content | ||
| </Card> | ||
| </CardGroup> | ||
| Learn more: [GitHub Repos (Docs as Code)](/docs/doc-collections/git-hub-repos-docs-as-code) | ||
|
|
||
| ## Multi-Platform Publishing | ||
|
|
||
| Promptless can publish to multiple documentation locations simultaneously, allowing you to use the same trigger events and context sources across different platforms. | ||
| Promptless can publish to multiple documentation repositories simultaneously, allowing you to use the same trigger events and context sources across different doc sites. | ||
|
|
||
| <Tip> | ||
| For teams using multiple platforms, create separate projects for each documentation location to maintain clear separation of content and workflows. | ||
| For teams using multiple doc sites, create separate projects for each documentation location to maintain clear separation of content and workflows. | ||
| </Tip> | ||
|
|
||
| ## Requesting Additional Platforms | ||
|
|
||
| Need integration with a platform not currently supported? We're continuously expanding our platform integrations based on user feedback. Contact [help@gopromptless.ai](mailto:help@gopromptless.ai). Also contact us if you're hoping to migrate to a new docs platform and we'll be happy to help you choose and set up! | ||
| Need integration with a Git-hosted platform not currently supported? We're continuously expanding our platform integrations based on user feedback. Contact help@gopromptless.ai. Also contact us if you're hoping to migrate to a new docs platform and we'll be happy to help you choose and set up! | ||
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 |
|---|---|---|
| @@ -1,52 +0,0 @@ | ||
| --- | ||
| title: Intercom (Beta) | ||
| --- | ||
|
|
||
| Intercom integration enables publishing documentation updates directly to your Intercom Help Center. This beta feature allows you to manage customer support documentation through the Promptless platform. | ||
|
|
||
| ## How It Works | ||
|
|
||
| When Intercom is configured as a documentation platform: | ||
|
|
||
| 1. **Review Suggestions**: Review documentation changes in the Promptless dashboard | ||
| 2. **Create Drafts**: Click "Save All & Update Intercom" to create drafts in your Intercom Help Center | ||
| 3. **Review in Intercom**: Drafts appear in your Intercom dashboard for final review | ||
| 4. **Publish**: Manually publish approved drafts from within Intercom | ||
|
|
||
| <Note> | ||
| The "Save All & Update Intercom" button creates or updates drafts in Intercom. You'll need to review and publish these drafts from within your Intercom dashboard before they become visible to your users. | ||
| </Note> | ||
|
|
||
| ## Publishing Options | ||
|
|
||
| When publishing to Intercom, you can: | ||
|
|
||
| - **Create New Articles**: Add new help center articles | ||
| - **Update Existing Articles**: Modify existing content with new information | ||
| - **Manage Article Metadata**: Update titles, descriptions, and categories | ||
| - **Add Images**: Include visual content in your help center articles | ||
|
|
||
| ## Beta Limitations | ||
|
|
||
| As this is a beta feature: | ||
|
|
||
| - Some advanced Intercom formatting options might not be fully supported | ||
| - Changes are always created as drafts for review | ||
| - Custom HTML and complex layouts should be verified in Intercom before publishing | ||
|
|
||
| ## Use Cases | ||
|
|
||
| Intercom as a documentation platform is especially useful for: | ||
|
|
||
| - **Customer Support Documentation**: Maintain help center content for your customers | ||
| - **In-App Help Articles**: Keep in-product help content up-to-date | ||
| - **Support Deflection**: Reduce support volume with better documentation | ||
| - **Onboarding Content**: Manage customer onboarding documentation | ||
|
|
||
| ## Setup Instructions | ||
|
|
||
| To connect Intercom to Promptless, see the [Intercom Integration](/docs/integrations/intercom-integration-beta) setup guide. | ||
|
|
||
| <Info> | ||
| Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Intercom integration for your account. | ||
| </Info> | ||
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 |
|---|---|---|
| @@ -1,44 +0,0 @@ | ||
| --- | ||
| title: Zendesk | ||
| --- | ||
|
|
||
| Zendesk integration enables publishing documentation updates directly to your Zendesk Help Center. This is useful for teams who manage customer-facing documentation through Zendesk's content management system. | ||
|
|
||
| ## How It Works | ||
|
|
||
| When Zendesk is configured as a documentation platform: | ||
|
|
||
| 1. **Review Suggestions**: Review documentation changes in the Promptless dashboard | ||
| 2. **Publish to Zendesk**: Click "Save All & Update Zendesk" to publish approved changes | ||
| 3. **Help Center Updates**: Content is created or updated in your Zendesk Help Center | ||
| 4. **Customer Access**: Updated articles are immediately available to your customers | ||
|
|
||
| ## Publishing Options | ||
|
|
||
| When publishing to Zendesk, you can: | ||
|
|
||
| - **Create New Articles**: Add new help center articles and knowledge base content | ||
| - **Update Existing Articles**: Modify existing content with new information | ||
| - **Manage Article Metadata**: Update titles, descriptions, tags, and categories | ||
| - **Add Images**: Include screenshots and diagrams in your help center content | ||
|
|
||
| ## Project Setup | ||
|
|
||
| Configure Zendesk as your documentation platform in your [project settings](https://app.gopromptless.ai/projects): | ||
|
|
||
| 1. Select Zendesk as your publishing destination | ||
| 2. Configure which categories or sections to publish to | ||
| 3. Set notification preferences | ||
|
|
||
| ## Use Cases | ||
|
|
||
| Zendesk as a documentation platform is especially useful for: | ||
|
|
||
| - **Customer Support Knowledge Base**: Maintain help center articles based on actual customer questions | ||
| - **Support Ticket Deflection**: Update documentation to reduce recurring support requests | ||
| - **Customer-Facing Documentation**: Manage end-user documentation outside of technical docs | ||
| - **FAQ Management**: Keep frequently asked questions up-to-date | ||
|
|
||
| ## Setup Instructions | ||
|
|
||
| To connect Zendesk to Promptless, see the [Zendesk Integration](/docs/integrations/zendesk-integration) setup guide. | ||
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
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
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
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 |
|---|---|---|
| @@ -1,27 +0,0 @@ | ||
| # Intercom Integration (Beta) | ||
|
|
||
| **Used for: Publishing** | ||
|
|
||
| Promptless offers beta support for updating documentation directly in Intercom. This integration allows you to manage your Intercom help center content through the Promptless platform. | ||
|
|
||
| <Info> | ||
| Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Intercom integration for your account. | ||
| </Info> | ||
|
|
||
| ## Setup | ||
|
|
||
| To set up the Intercom integration: | ||
|
|
||
| 1. Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Intercom integration for your account | ||
| 2. Configure your Intercom credentials in the Promptless dashboard | ||
| 3. Select Intercom as your documentation platform when creating a new project | ||
|
|
||
| ## What You Can Do with Intercom | ||
|
|
||
| Once connected, you can use Intercom as a [documentation platform](/docs/configuring-promptless/doc-collections/intercom-beta) to publish help center articles and customer support documentation. | ||
|
|
||
| <Note> | ||
| The Intercom integration creates or updates drafts in Intercom. You'll need to review and publish these drafts from within your Intercom dashboard before they become visible to your users. | ||
| </Note> | ||
|
|
||
| For any questions or issues with the Intercom integration, please contact our support team at [help@gopromptless.ai](mailto:help@gopromptless.ai). | ||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Citation: Per @prithvi's request, moved "How Promptless Learns Your Docs" article from Getting Started to the Doc Collections section.
View source