Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions fern/docs.yml
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Line 60)

Citation: Removed Zendesk trigger and integration navigation entries based on PR #2378 which explicitly drops /integrations/zendesk route with 410 "unsupported_in_v2_scope" response.
View source

Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -60,8 +58,6 @@ navigation:
path: ./docs/configuration/triggers/slack.md
- page: Microsoft Teams Messages
path: ./docs/configuration/triggers/microsoft-teams.md
- page: Zendesk Tickets (Beta)
path: ./docs/configuration/triggers/zendesk.md
- section: Context Sources
path: ./docs/configuration/context-sources.md
contents:
Expand All @@ -74,12 +70,10 @@ navigation:
- section: Doc Collections
path: ./docs/configuration/doc-collections.md
contents:
- page: How Promptless Learns Your Docs
Copy link
Contributor Author

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

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
Expand Down Expand Up @@ -115,10 +109,6 @@ navigation:
slug: slack-integration
- page: Microsoft Teams Integration
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:
Expand Down
30 changes: 8 additions & 22 deletions fern/docs/configuration/doc-collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor Author

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 to move to docs-as-code only, removed Zendesk and Intercom as publishing destinations and refocused documentation on Git-hosted platforms.
View source


## 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
Expand All @@ -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!
52 changes: 0 additions & 52 deletions fern/docs/configuration/doc-collections/intercom.md
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>
44 changes: 0 additions & 44 deletions fern/docs/configuration/doc-collections/zendesk.md
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.
8 changes: 2 additions & 6 deletions fern/docs/configuration/triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,13 @@ Triggers are events that initiate automated documentation updates in Promptless.
<Card title="Microsoft Teams" icon="fa-brands fa-microsoft" href="/docs/configuring-promptless/triggers/microsoft-teams-messages">
Trigger updates from Microsoft Teams messages and mentions
</Card>

<Card title="Zendesk (Beta)" icon="fa-solid fa-ticket" href="/docs/configuring-promptless/triggers/zendesk-tickets-beta">
Monitor support tickets for documentation gaps based on recurring user questions
</Card>
</CardGroup>

## How Triggers Work

When a trigger event occurs:

1. **Event Detection**: Promptless receives notification of the event (PR opened, message posted, ticket resolved)
1. **Event Detection**: Promptless receives notification of the event (PR opened, message posted, etc.)
2. **Context Analysis**: The system analyzes the event content, including code changes, conversations, or support interactions
3. **Relevance Assessment**: Promptless determines if the event requires documentation updates
4. **Suggestion Creation**: If relevant, Promptless creates documentation suggestions based on the trigger content and connected context sources
Expand All @@ -54,7 +50,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

Expand Down
40 changes: 0 additions & 40 deletions fern/docs/configuration/triggers/zendesk.md

This file was deleted.

12 changes: 5 additions & 7 deletions fern/docs/core-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The diagram below illustrates how triggers, context sources, and documentation p
graph LR
%% Triggers Section
subgraph "Triggers"
T1[GitHub PR<br/>Slack message<br/>Support ticket]
T1[GitHub PR<br/>Slack message<br/>MS Teams message]
end

%% Promptless Core
Expand All @@ -25,7 +25,7 @@ graph LR

%% Documentation Platforms
subgraph "Documentation Platforms"
D1[Git-hosted docs<br/>Zendesk Help Center<br/>Intercom]
D1[Git-hosted docs]
end

%% Connections
Expand Down Expand Up @@ -55,7 +55,6 @@ graph LR

- **Code Changes**: Pull requests in GitHub, Bitbucket, or GitLab automatically trigger analysis when new features or fixes are introduced
- **Team Communication**: Slack messages and Microsoft Teams mentions can trigger documentation updates
- **Support Patterns (Beta)**: Zendesk tickets help identify gaps in documentation based on recurring user questions

Learn more in [Configuring Promptless → Triggers](/docs/configuring-promptless/triggers).

Expand All @@ -77,11 +76,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

Expand Down
4 changes: 2 additions & 2 deletions fern/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ For account creation and team management questions, please see our [Account Mana

Promptless integrates with a wide variety of platforms for triggers, context, and publishing:

- **Triggers**: GitHub, Bitbucket, GitLab, Slack, Microsoft Teams, Zendesk
- **Triggers**: GitHub, Bitbucket, GitLab, Slack, Microsoft Teams
- **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).

Expand Down
5 changes: 2 additions & 3 deletions fern/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When you first sign in, a 6-step wizard guides you through setup:
</Step>

<Step title="Connect docs">
Connect your documentation platform (GitHub repos, Zendesk, or other supported platforms)
Connect your documentation repository (GitHub or other Git providers)
</Step>

<Step title="Configure triggers">
Expand Down Expand Up @@ -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.

Expand Down
10 changes: 5 additions & 5 deletions fern/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Promptless operates through three interconnected components that work together t

```mermaid
graph LR
TRIGGERS["GitHub PR, Slack message,<br/>Support ticket"]
TRIGGERS["GitHub PR, Slack message,<br/>MS Teams message"]
CONTEXT["Linear, Jira, GitHub,<br/>Slack, Google Drive"]
DOCS["Git-hosted docs, ReadMe,<br/>Help Center"]
DOCS["Git-hosted docs"]

TRIGGERS --> PROMPTLESS
PROMPTLESS["Promptless"]
Expand All @@ -46,15 +46,15 @@ graph LR

<CardGroup cols={1}>
<Card title="Intelligent Triggers" icon="fa-regular fa-bolt" href="/docs/configuring-promptless/triggers">
Monitor your development ecosystem for events that indicate documentation needs—from pull requests and code changes to team discussions and support tickets.
Monitor your development ecosystem for events that indicate documentation needs—from pull requests and code changes to team discussions.
</Card>

<Card title="Contextual Understanding" icon="fa-regular fa-brain" href="/docs/configuring-promptless/context-sources">
Enrich docs with real-time access to your organization's knowledge through integrations with project management tools, code repositories, and team communications.
</Card>

<Card title="Multi-Platform Publishing" icon="fa-regular fa-share-nodes" href="/docs/configuring-promptless/doc-collections">
Distribute updates across your entire docs ecosystem—from GitHub-synced platforms to help centers and content management systems.
<Card title="Docs-as-Code Publishing" icon="fa-regular fa-share-nodes" href="/docs/configuring-promptless/doc-collections">
Publish updates to your Git-hosted documentation platforms—Fern, Mintlify, ReadMe, Docusaurus, GitBook, and more.
</Card>
</CardGroup>

Expand Down
11 changes: 3 additions & 8 deletions fern/docs/integrations/index.mdx
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -18,11 +18,6 @@ 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)

## Managing Integrations

Expand Down
Loading