diff --git a/fern/docs.yml b/fern/docs.yml index 18043533..e4964bd1 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -36,8 +36,6 @@ navigation: path: ./docs/getting-started.mdx - page: Core Concepts path: ./docs/core-concepts.mdx - - page: How Promptless Learns Your Docs - path: ./docs/doc-analysis.mdx - page: Promptless for Open-Source slug: promptless-oss path: ./docs/open-source.mdx @@ -74,12 +72,10 @@ navigation: - section: Doc Collections path: ./docs/configuration/doc-collections.md contents: + - page: How Promptless Learns Your Docs + path: ./docs/doc-analysis.mdx - page: GitHub Repos (Docs as Code) path: ./docs/configuration/doc-collections/github-repos.md - - page: Zendesk - path: ./docs/configuration/doc-collections/zendesk.md - - page: Intercom (Beta) - path: ./docs/configuration/doc-collections/intercom.md - section: How to use Promptless icon: fa-regular fa-star path: ./docs/features/index.mdx @@ -117,8 +113,6 @@ navigation: path: ./docs/integrations/microsoft-teams.mdx - page: Zendesk Integration path: ./docs/integrations/zendesk.mdx - - page: Intercom Integration (Beta) - path: ./docs/integrations/intercom.md - section: Account Management icon: fa-regular fa-users contents: diff --git a/fern/docs/configuration/doc-collections.md b/fern/docs/configuration/doc-collections.md index ec005fd4..ed64db6c 100644 --- a/fern/docs/configuration/doc-collections.md +++ b/fern/docs/configuration/doc-collections.md @@ -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. -## 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. - - - - Help center articles and knowledge base content management - - - - Customer support documentation and help center content - - +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. -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. ## 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! diff --git a/fern/docs/configuration/doc-collections/intercom.md b/fern/docs/configuration/doc-collections/intercom.md index 97e54eb3..e69de29b 100644 --- a/fern/docs/configuration/doc-collections/intercom.md +++ b/fern/docs/configuration/doc-collections/intercom.md @@ -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 - - -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. - - -## 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. - - -Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Intercom integration for your account. - diff --git a/fern/docs/configuration/doc-collections/zendesk.md b/fern/docs/configuration/doc-collections/zendesk.md index 5d7782c5..e69de29b 100644 --- a/fern/docs/configuration/doc-collections/zendesk.md +++ b/fern/docs/configuration/doc-collections/zendesk.md @@ -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. diff --git a/fern/docs/configuration/triggers.md b/fern/docs/configuration/triggers.md index b597d74a..ae1baf87 100644 --- a/fern/docs/configuration/triggers.md +++ b/fern/docs/configuration/triggers.md @@ -54,7 +54,7 @@ Need a trigger type that isn't currently supported? Contact us at [help@goprompt When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. For [commit triggers](/docs/configuring-promptless/triggers/git-hub-commits), you can optionally enable auto-merge to automatically merge documentation PRs as soon as they're created. -Auto-publish is available for GitHub-based documentation platforms. For CMS platforms like Zendesk or Intercom, documentation updates are created as drafts for review. +Auto-publish is available for all Git-hosted documentation platforms. ## Trigger Events in Documentation PRs diff --git a/fern/docs/core-concepts.mdx b/fern/docs/core-concepts.mdx index 8f850994..975c0e92 100644 --- a/fern/docs/core-concepts.mdx +++ b/fern/docs/core-concepts.mdx @@ -25,7 +25,7 @@ graph LR %% Documentation Platforms subgraph "Documentation Platforms" - D1[Git-hosted docs
Zendesk Help Center
Intercom] + D1[Git-hosted docs] end %% Connections @@ -77,11 +77,10 @@ Learn more in [Configuring Promptless → Context Sources](/docs/configuring-pro **Documentation Platforms** are where the final documentation updates are published: -- **Git-hosted Platforms**: Most common setup where docs are stored in Git and synced to hosting providers -- **Direct Platform Integration**: Beta support for publishing directly to Zendesk and Intercom -- **Multi-platform Publishing**: Single trigger can update multiple documentation platforms simultaneously +- **Git-hosted Platforms**: Docs are stored in Git and synced to hosting providers like Fern, Mintlify, Docusaurus, and more +- **Multi-platform Publishing**: Single trigger can update multiple documentation repositories simultaneously -Learn more in [Configuring Promptless → Doc Collections](/docs/configuring-promptless/doc-collections). +Learn more in [Configuring Promptless → Doc Collections](/docs/doc-collections). ## Key Benefits of This Architecture diff --git a/fern/docs/faq.mdx b/fern/docs/faq.mdx index 33a6f4af..36b3c566 100644 --- a/fern/docs/faq.mdx +++ b/fern/docs/faq.mdx @@ -14,7 +14,7 @@ Promptless integrates with a wide variety of platforms for triggers, context, an - **Triggers**: GitHub, Bitbucket, GitLab, Slack, Microsoft Teams, Zendesk - **Context Sources**: Linear, Jira, GitHub Issues, Google Drive -- **Publishing**: GitHub-synced docs (Fern, Mintlify, Docusaurus, etc.), ReadMe, Zendesk, Intercom, Notion (beta) +- **Publishing**: Git-hosted docs (Fern, Mintlify, Docusaurus, ReadMe, GitBook, MkDocs, and more) For a complete list, see our [Integrations overview](/docs/integrations). diff --git a/fern/docs/getting-started.mdx b/fern/docs/getting-started.mdx index 89234b85..eea1cf5a 100644 --- a/fern/docs/getting-started.mdx +++ b/fern/docs/getting-started.mdx @@ -16,7 +16,7 @@ When you first sign in, a 6-step wizard guides you through setup: - Connect your documentation platform (GitHub repos, Zendesk, or other supported platforms) + Connect your documentation repository (GitHub or other Git providers) @@ -47,8 +47,7 @@ During setup, you'll connect: - **Slack**: Manual triggers via @mentions or message actions **Documentation Platform** - Where your docs live -- **GitHub repos**: Most common setup. Supports many hosting providers like ReadMe, Mintlify, Fern, and more. -- **Hosted CMSs**: Zendesk supported today. More coming soon! +- **GitHub repos**: Supports docs-as-code platforms like ReadMe, Mintlify, Fern, Docusaurus, and more **Enhanced Context (optional)** - Connect **Linear**, **Jira**, **Confluence**, or **Slack** to provide Promptless with additional context for better suggestions. diff --git a/fern/docs/index.mdx b/fern/docs/index.mdx index 3d8feb86..d7c305f5 100644 --- a/fern/docs/index.mdx +++ b/fern/docs/index.mdx @@ -31,7 +31,7 @@ Promptless operates through three interconnected components that work together t graph LR TRIGGERS["GitHub PR, Slack message,
Support ticket"] CONTEXT["Linear, Jira, GitHub,
Slack, Google Drive"] - DOCS["Git-hosted docs, ReadMe,
Help Center"] + DOCS["Git-hosted docs
(Fern, Mintlify, ReadMe, etc.)"] TRIGGERS --> PROMPTLESS PROMPTLESS["Promptless"] @@ -53,8 +53,8 @@ graph LR Enrich docs with real-time access to your organization's knowledge through integrations with project management tools, code repositories, and team communications. - - Distribute updates across your entire docs ecosystem—from GitHub-synced platforms to help centers and content management systems. + + Publish updates to your Git-hosted documentation platforms—Fern, Mintlify, ReadMe, Docusaurus, GitBook, and more. diff --git a/fern/docs/integrations/index.mdx b/fern/docs/integrations/index.mdx index 93a56c05..b4acf78f 100644 --- a/fern/docs/integrations/index.mdx +++ b/fern/docs/integrations/index.mdx @@ -1,11 +1,11 @@ # Integrations -Promptless offers several key integrations to help automate and improve your documentation workflow. +Promptless offers several key integrations to help automate and improve your documentation workflow. -Integrations can be used for: +Integrations can be used for: 1. Triggers (i.e. to generate events, either automatically or manually, upon which Promptless gets notified) 2. Context (i.e. to allow Promptless to search for relevant information in its research) -3. Publishing (i.e. to push documentation updates to a given CMS) +3. Publishing (i.e. to push documentation updates to your Git-hosted docs) Some integrations can be used for multiple purposes. Some integrations are in a beta state and may not be listed here. For the most up to date list of integrations, please contact us at help@gopromptless.ai. @@ -18,11 +18,7 @@ Some integrations can be used for multiple purposes. Some integrations are in a - [Linear](/docs/integrations/linear-integration): Look up relevant Linear issues and projects within a team when being triggered - [Microsoft Teams](/docs/integrations/microsoft-teams-integration): Trigger based on mentions and message actions in Microsoft Teams - [Slack](/docs/integrations/slack-integration): Trigger based on DMs or message actions in Slack -- [Zendesk](/docs/integrations/zendesk-integration): Trigger based on resolved support tickets, and publish to Zendesk help center - -### Beta Integrations - -- [Intercom](/docs/integrations/intercom-integration-beta): Publish documentation updates directly to Intercom help center (Beta, contact help@gopromptless.ai to get access) +- [Zendesk](/docs/integrations/zendesk-integration): Trigger based on resolved support tickets ## Managing Integrations diff --git a/fern/docs/integrations/intercom.md b/fern/docs/integrations/intercom.md index 1cca8447..e69de29b 100644 --- a/fern/docs/integrations/intercom.md +++ b/fern/docs/integrations/intercom.md @@ -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. - - -Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Intercom integration for your account. - - -## 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. - - -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. - - -For any questions or issues with the Intercom integration, please contact our support team at [help@gopromptless.ai](mailto:help@gopromptless.ai). diff --git a/fern/docs/integrations/zendesk.mdx b/fern/docs/integrations/zendesk.mdx index ad7ec674..9ed36113 100644 --- a/fern/docs/integrations/zendesk.mdx +++ b/fern/docs/integrations/zendesk.mdx @@ -1,8 +1,8 @@ # Zendesk Integration -**Used for: Triggers and Publishing** +**Used for: Triggers** -Promptless integrates with Zendesk through OAuth 2.0, enabling automated documentation updates based on support ticket patterns and customer interactions, as well as publishing updates to Zendesk's Help Center. +Promptless integrates with Zendesk through OAuth 2.0, enabling automated documentation updates based on support ticket patterns and customer interactions. ## Installation @@ -26,7 +26,4 @@ Promptless uses Zendesk's [official OAuth 2.0 authentication](https://developer. ## What You Can Do with Zendesk -Once connected, you can use Zendesk for: - -- **[Triggers](/docs/configuring-promptless/triggers/zendesk-tickets-beta)**: Monitor resolved support tickets for documentation gaps (Beta) -- **[Doc Collections](/docs/configuring-promptless/doc-collections/zendesk)**: Publish documentation updates directly to your Zendesk Help Center +Once connected, you can use Zendesk as a [trigger source](/docs/triggers/zendesk-tickets-beta) to monitor resolved support tickets for documentation gaps (Beta). diff --git a/fern/docs/introducing-promptless.mdx b/fern/docs/introducing-promptless.mdx index a750dd55..2b7e337e 100644 --- a/fern/docs/introducing-promptless.mdx +++ b/fern/docs/introducing-promptless.mdx @@ -26,7 +26,7 @@ Here's a quick summary of what Promptless 1.0 brings: src="./assets/promptless_1_listen.png" imagePosition="left" > - Promptless integrates with GitHub, Slack, Linear, Jira, Zendesk, and your documentation platform. It listens for events such as PR merges, ticket closes, and support conversations in Slack. + Promptless integrates with GitHub, Slack, Linear, Jira, Zendesk, and your docs repo. It listens for events such as PR merges, ticket closes, and support conversations in Slack. @@ -56,7 +56,7 @@ Here's a quick summary of what Promptless 1.0 brings: src="./assets/promptless_1_publish.png" imagePosition="left" > - Open PRs to your docs repo or deploy directly to your docs provider—Mintlify, Fern, Readme, GitBook, Zendesk, and more. Complete end-to-end automation from code changes to published documentation. + Open PRs to your docs repo and deploy directly through your docs provider—Mintlify, Fern, ReadMe, GitBook, Docusaurus, and more. Complete end-to-end automation from code changes to published documentation. diff --git a/fern/docs/pilot-guide.mdx b/fern/docs/pilot-guide.mdx index c933360d..dd24117a 100644 --- a/fern/docs/pilot-guide.mdx +++ b/fern/docs/pilot-guide.mdx @@ -24,8 +24,8 @@ Before the pilot begins, you'll need to connect Promptless to your relevant work Connect GitHub, GitHub Enterprise, GitLab, or Bitbucket - - Connect your documentation CMS or publishing platform, whether on Github (e.g. if you use Mintlify, Fern, Readme, Docusaurus, etc) or on a CMS like Zendesk. + + Connect your docs repository on GitHub, GitLab, or Bitbucket (e.g. if you use Mintlify, Fern, ReadMe, Docusaurus, etc.) diff --git a/fern/docs/recommended-docs-providers.mdx b/fern/docs/recommended-docs-providers.mdx index 6b6e9659..a5737871 100644 --- a/fern/docs/recommended-docs-providers.mdx +++ b/fern/docs/recommended-docs-providers.mdx @@ -30,5 +30,5 @@ When evaluating documentation platforms, the key factors to consider are: - **Developer experience**: Interactive API playground, code samples, and testing tools -Promptless works with all of these platforms, and more. If your docs can be synced to a git repo, Promptless can automatically create PRs with documentation updates. For hosted platforms like Zendesk, Promptless can publish updates directly. +Promptless works with all of these platforms, and more. If your docs can be synced to a git repo, Promptless can automatically create PRs with documentation updates. diff --git a/fern/docs/security-and-privacy/subprocessors.md b/fern/docs/security-and-privacy/subprocessors.md index 8734e0e6..6c69e0f9 100644 --- a/fern/docs/security-and-privacy/subprocessors.md +++ b/fern/docs/security-and-privacy/subprocessors.md @@ -41,6 +41,6 @@ Enterprise customers have additional flexibility: ### Third-party Integrations -Promptless supports a number of third-party integrations that customers can choose to use in their projects, such as GitHub, Slack, Intercom, Linear, Notion, Jira, and more. +Promptless supports a number of third-party integrations that customers can choose to use in their projects, such as GitHub, Slack, Linear, Jira, and more. For the most current information about our subprocessors or to discuss specific security requirements, please contact our security team at help@gopromptless.ai. \ No newline at end of file