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
2 changes: 1 addition & 1 deletion fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ navigation:
path: ./docs/core-concepts/triggers.md
- page: Context Sources
path: ./docs/core-concepts/context-sources.md
- page: Doc CMSs
- page: Doc Platforms
path: ./docs/core-concepts/doc-locations.md
- section: How to use Promptless
icon: fa-regular fa-star
Expand Down
8 changes: 4 additions & 4 deletions fern/docs/core-concepts/doc-locations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Documentation Platforms

Documentation platforms are where your docs live. Whether you're using Git-synced CMSs such as Fern, Mintlify, Docusaurus, or other platforms such as Readme, Zendesk, and Intercom, you'll need to enable Promptless integrations to read from and publish to your existing docs.
Documentation platforms are where your docs live. Whether you're using Git-synced platforms such as Fern, Mintlify, Docusaurus, or other platforms such as Readme, Zendesk, and Intercom, you'll need to enable Promptless integrations to read from and publish to your existing docs.

## GitHub-Synced Documentation Platforms

Expand All @@ -15,13 +15,13 @@ The most common setup uses the **Promptless GitHub App** to integrate with docum
- Ghost
- Nextra
- Vocs
- Custom CMS as long as the content is in a repo
- Custom platform as long as the content is in a repo

For more detailed step-by-step instructions, go to the [GitHub integrations page](/docs/integrations/github-integration).

## Direct CMS Platform Integrations
## Direct Platform Integrations

For teams using content management systems that don't sync with GitHub, Promptless offers direct integrations with popular CMS platforms.
For teams using content management systems that don't sync with GitHub, Promptless offers direct integrations with popular documentation platforms.

<CardGroup cols={2}>
<Card title="Zendesk" href="/docs/integrations/zendesk-integration">
Expand Down
16 changes: 8 additions & 8 deletions fern/docs/core-concepts/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Promptless automates documentation creation and maintenance through three interc

## Overview

The diagram below illustrates how triggers, context sources, and documentation CMSs interact within the Promptless ecosystem:
The diagram below illustrates how triggers, context sources, and documentation platforms interact within the Promptless ecosystem:

```mermaid
graph TB
Expand All @@ -28,8 +28,8 @@ graph TB
AI[Promptless AI Agent]
end

%% Documentation CMSs
subgraph "Documentation CMSs"
%% Documentation Platforms
subgraph "Documentation Platforms"
D1[GitHub-synced Docs<br/>ReadMe, Mintlify, Docusaurus]
D2[Zendesk<br/>Help Center]
D3[Intercom<br/>Help Center]
Expand All @@ -54,12 +54,12 @@ graph TB
classDef triggerStyle fill:#e1f5fe,stroke:#0277bd,stroke-width:2px,color:#000000
classDef contextStyle fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px,color:#000000
classDef coreStyle fill:#fff3e0,stroke:#ef6c00,stroke-width:3px,color:#000000
classDef cmsStyle fill:#e8f5e8,stroke:#2e7d32,stroke-width:2px,color:#000000
classDef platformStyle fill:#e8f5e8,stroke:#2e7d32,stroke-width:2px,color:#000000

class T1,T2,T3 triggerStyle
class C1,C2,C3 contextStyle
class AI coreStyle
class D1,D2,D3,D4 cmsStyle
class D1,D2,D3,D4 platformStyle
```

## How the Components Work Together
Expand All @@ -84,12 +84,12 @@ graph TB
Context sources are queried in real-time and no customer data is stored by Promptless, ensuring your sensitive information remains secure.
</Note>

### 3. Documentation CMSs Receive Updates
### 3. Documentation Platforms Receive Updates

**Documentation CMSs** are where the final documentation updates are published:
**Documentation Platforms** are where the final documentation updates are published:

- **GitHub-synced Platforms**: Most common setup where docs are stored in Git and synced to hosting providers
- **Direct CMS Integration**: Beta support for publishing directly to Zendesk, Intercom, and Webflow
- **Direct Platform Integration**: Beta support for publishing directly to Zendesk, Intercom, and Webflow
- **Multi-platform Publishing**: Single trigger can update multiple documentation platforms simultaneously

## Key Benefits of This Architecture
Expand Down
2 changes: 1 addition & 1 deletion fern/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Promptless operates through three interconnected components that work together t
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/core-concepts/doc-cm-ss">
<Card title="Multi-Platform Publishing" icon="fa-regular fa-share-nodes" href="/docs/core-concepts/doc-platforms">
Distribute updates across your entire docs ecosystem—from GitHub-synced platforms to help centers and content management systems.
</Card>
</CardGroup>
Expand Down
2 changes: 1 addition & 1 deletion fern/docs/integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Promptless offers several key integrations to help automate and improve your doc
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 a given platform)

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 [email protected].

Expand Down