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
35 changes: 35 additions & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: check-internal-links

on:
pull_request:
paths:
- 'fern/docs/**'
- 'fern/docs.yml'
- 'scripts/valid-urls.txt'
push:
branches:
- main
paths:
- 'fern/docs/**'
- 'fern/docs.yml'
- 'scripts/valid-urls.txt'

jobs:
check-links:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'

- name: Install dependencies
run: pip install pyyaml

- name: Check internal links
run: |
chmod +x scripts/check-internal-links.sh
./scripts/check-internal-links.sh
6 changes: 3 additions & 3 deletions fern/docs/configuration/context-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ Context sources are **optional** but highly recommended. They can significantly
## Available Context Sources

<CardGroup cols={2}>
<Card title="Linear" icon="fa-solid fa-circle" href="/docs/configuration/context-sources/linear">
<Card title="Linear" icon="fa-solid fa-circle" href="/docs/context-sources/linear">
Access Linear issues, projects, and team workflows for project management context
</Card>

<Card title="Jira" icon="fa-brands fa-jira" href="/docs/configuration/context-sources/jira">
<Card title="Jira" icon="fa-brands fa-jira" href="/docs/context-sources/jira">
Query Jira tickets and project data using JQL search capabilities
</Card>

<Card title="Confluence" icon="fa-brands fa-confluence" href="/docs/configuration/context-sources/confluence">
<Card title="Confluence" icon="fa-brands fa-confluence" href="/docs/context-sources/confluence">
Search Confluence spaces for existing documentation patterns, terminology, and architectural decisions
</Card>
</CardGroup>
Expand Down
12 changes: 8 additions & 4 deletions fern/docs/configuration/doc-collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
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 platforms where your documentation lives. Whether you're using Git-synced platforms such as Fern, Mintlify, or Docusaurus, or standalone platforms such as Zendesk, Intercom, and Webflow, you'll need to configure Promptless to read from and publish to your existing docs.

## Git-hosted Documentation Platforms

Expand All @@ -20,20 +20,24 @@ 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/configuration/doc-collections/github-repos)
Learn more: [GitHub Repos (Docs as Code)](/docs/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/configuration/doc-collections/zendesk">
<Card title="Zendesk" icon="fa-solid fa-ticket" href="/docs/doc-collections/zendesk">
Help center articles and knowledge base content management
</Card>

<Card title="Intercom" icon="fa-solid fa-comments" href="/docs/configuration/doc-collections/intercom">
<Card title="Intercom (Beta)" icon="fa-solid fa-comments" href="/docs/doc-collections/intercom-beta">
Customer support documentation and help center content
</Card>

<Card title="Webflow (Beta)" icon="fa-solid fa-w" href="/docs/doc-collections/webflow-beta">
Blog posts, collection items, and marketing site content
</Card>
</CardGroup>

## Multi-Platform Publishing
Expand Down
2 changes: 1 addition & 1 deletion fern/docs/configuration/doc-collections/intercom.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Intercom as a documentation platform is especially useful for:

## Setup Instructions

To connect Intercom to Promptless, see the [Intercom Integration](/docs/integrations/intercom) setup guide.
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.
Expand Down
66 changes: 66 additions & 0 deletions fern/docs/configuration/doc-collections/webflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: Webflow (Beta)
---

Webflow integration enables publishing content updates directly to your Webflow CMS. This beta feature allows you to manage blog posts, collection items, and other CMS content through the Promptless platform.

## How It Works

When Webflow is configured as a documentation platform:

1. **Review Suggestions**: Review content changes in the Promptless dashboard
2. **Publish to Webflow**: Click "Save All & Update Webflow" to publish approved changes
3. **CMS Updates**: Content is created or updated in your Webflow CMS
4. **Site Publishing**: Content is automatically published to your live site (if auto-publish is enabled)

## Content Types Supported

Webflow integration supports various content types:

- **Blog Posts**: Articles, announcements, updates
- **Collection Items**: Custom content types defined in your Webflow CMS
- **Static Pages**: About pages, landing pages, documentation pages
- **Rich Content**: Text formatting, images, links, and embedded media

## Publishing Options

You can configure how Promptless publishes to Webflow:

- **Draft Mode**: Create content as drafts for manual review and publishing
- **Auto-publish**: Automatically publish approved content to your live site
- **Staging**: Publish to a staging environment first for testing

## Managing Blog Posts

Promptless can help you manage your Webflow blog posts by:

- **Creating New Posts**: Add new articles, announcements, or content pages
- **Updating Existing Posts**: Modify content, add new sections, or update information
- **Managing Metadata**: Update titles, descriptions, tags, and other CMS fields
- **Adding Images**: Include screenshots, diagrams, and other visual content

## Beta Limitations

As this is a beta feature:

- Some advanced Webflow CMS field types might not be fully supported
- Custom code and complex layouts should be verified in Webflow after publishing
- Rich text formatting may require manual adjustment for optimal display
- Collection structure changes should be made directly in Webflow

## Use Cases

Webflow as a documentation platform is especially useful for:

- **Marketing Content**: Blog posts and marketing site content
- **Product Documentation**: Technical documentation alongside marketing content
- **Changelog Publishing**: Keep product changelogs up-to-date
- **Content Marketing**: Manage blog and content marketing at scale

## Setup Instructions

To connect Webflow to Promptless, see the [Webflow Integration](/docs/integrations/webflow-integration-beta) setup guide.

<Info>
Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Webflow integration for your account.
</Info>
2 changes: 1 addition & 1 deletion fern/docs/configuration/doc-collections/zendesk.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ Zendesk as a documentation platform is especially useful for:

## Setup Instructions

To connect Zendesk to Promptless, see the [Zendesk Integration](/docs/integrations/zendesk) setup guide.
To connect Zendesk to Promptless, see the [Zendesk Integration](/docs/integrations/zendesk-integration) setup guide.
12 changes: 6 additions & 6 deletions fern/docs/configuration/triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@ Triggers are events that initiate automated documentation updates in Promptless.
## Available Trigger Types

<CardGroup cols={2}>
<Card title="GitHub PRs" icon="fa-brands fa-github" href="/docs/configuration/triggers/github-prs">
<Card title="GitHub PRs" icon="fa-brands fa-github" href="/docs/triggers/git-hub-p-rs">
Automatically triggered when pull requests are opened in your GitHub repositories
</Card>

<Card title="GitHub Commits" icon="fa-brands fa-github" href="/docs/configuration/triggers/github-commits">
<Card title="GitHub Commits" icon="fa-brands fa-github" href="/docs/triggers/git-hub-commits">
Monitor direct commits to default branches for documentation updates
</Card>

<Card title="Slack" icon="brands slack" href="/docs/configuration/triggers/slack">
<Card title="Slack" icon="brands slack" href="/docs/triggers/slack-messages">
Trigger updates from Slack conversations and support threads
</Card>

<Card title="Microsoft Teams" icon="fa-brands fa-microsoft" href="/docs/configuration/triggers/microsoft-teams">
<Card title="Microsoft Teams" icon="fa-brands fa-microsoft" href="/docs/triggers/microsoft-teams-messages">
Trigger updates from Microsoft Teams messages and mentions
</Card>

<Card title="Zendesk (Beta)" icon="fa-solid fa-ticket" href="/docs/configuration/triggers/zendesk">
<Card title="Zendesk (Beta)" icon="fa-solid fa-ticket" href="/docs/triggers/zendesk-tickets-beta">
Monitor support tickets for documentation gaps based on recurring user questions
</Card>
</CardGroup>
Expand Down Expand Up @@ -52,7 +52,7 @@ Need a trigger type that isn't currently supported? Contact us at [help@goprompt

## Auto-publish Mode

When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. For [commit triggers](/docs/configuration/triggers/github-commits), you can optionally enable auto-merge to automatically merge documentation PRs as soon as they're created.
When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. 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.

Expand Down
2 changes: 1 addition & 1 deletion fern/docs/configuration/triggers/microsoft-teams.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Promptless only reads Microsoft Teams content when you explicitly trigger it by

## Setup Instructions

To connect Microsoft Teams to Promptless, see the [Microsoft Teams Integration](/docs/integrations/microsoft-teams) setup guide.
To connect Microsoft Teams to Promptless, see the [Microsoft Teams Integration](/docs/integrations/microsoft-teams-integration) setup guide.

<Info>
Microsoft Teams integration requires admin center access to install the Promptless Teams app. See the setup guide for detailed installation instructions.
Expand Down
2 changes: 1 addition & 1 deletion fern/docs/configuration/triggers/zendesk.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Zendesk triggers are especially useful for:

## Setup Instructions

To connect Zendesk to Promptless, see the [Zendesk Integration](/docs/integrations/zendesk) setup guide.
To connect Zendesk to Promptless, see the [Zendesk Integration](/docs/integrations/zendesk-integration) setup guide.
10 changes: 5 additions & 5 deletions fern/docs/core-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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<br/>Zendesk Help Center<br/>Intercom, Webflow]
end

%% Connections
Expand Down Expand Up @@ -57,7 +57,7 @@ graph LR
- **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/configuration/triggers).
Learn more in [Configuring Promptless → Triggers](/docs/triggers).

### 2. Context Sources Enrich Promptless's Understanding

Expand All @@ -71,17 +71,17 @@ Learn more in [Configuring Promptless → Triggers](/docs/configuration/triggers
Context sources are queried in real-time and no customer data is stored by Promptless, ensuring your sensitive information remains secure.
</Note>

Learn more in [Configuring Promptless → Context Sources](/docs/configuration/context-sources).
Learn more in [Configuring Promptless → Context Sources](/docs/context-sources).

### 3. Documentation Platforms Receive Updates

**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
- **Direct Platform Integration**: Beta support for publishing directly to Zendesk, Intercom, and Webflow
- **Multi-platform Publishing**: Single trigger can update multiple documentation platforms simultaneously

Learn more in [Configuring Promptless → Doc Collections](/docs/configuration/doc-collections).
Learn more in [Configuring Promptless → Doc Collections](/docs/doc-collections).

## Key Benefits of This Architecture

Expand Down
6 changes: 3 additions & 3 deletions fern/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Here you'll find answers to common questions about using Promptless.

## Getting Started & Onboarding

For account creation and team management questions, please see our [Account Management](/docs/managing-accounts) page.
For account creation and team management questions, please see our [Account Management](/docs/account-management) page.

## Platform Usage

Expand All @@ -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**: GitHub-synced docs (Fern, Mintlify, Docusaurus, etc.), ReadMe, Zendesk, Intercom, Webflow, Notion (beta)

For a complete list, see our [Integrations overview](/docs/integrations).

Expand All @@ -24,7 +24,7 @@ By default, no. Promptless only accesses Slack content when you explicitly trigg

However, you can optionally enable **passive listening** for specific channels. When enabled, Promptless will monitor only the channels you explicitly select in your project configuration. This is completely opt-in - you choose which channels to monitor and can add or remove channels at any time. If you don't enable this option, we will not be monitoring any slack channels.

For more details, see our [Slack Integration documentation](/docs/integrations/slack-integration) and [Working with Slack](/docs/features/slack-interactions#4-passive-channel-listening).
For more details, see our [Slack Integration documentation](/docs/integrations/slack-integration) and [Working with Slack](/docs/how-to-use-promptless/working-with-slack#4-passive-channel-listening).

### Does Promptless analyze my entire codebase?

Expand Down
6 changes: 3 additions & 3 deletions fern/docs/features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Promptless offers multiple ways to interact with the platform and generate docum
## Interaction Methods

<CardGroup cols={1}>
<Card title="Working with Slack" icon="brands slack" href="/how-to-use-promptless/working-with-slack">
<Card title="Working with Slack" icon="brands slack" href="/docs/how-to-use-promptless/working-with-slack">
Use message actions, DMs, and channel mentions to trigger documentation updates and follow-up edits directly from Slack conversations.
</Card>

<Card title="Interacting with Promptless PRs" icon="brands github" href="/how-to-use-promptless/interacting-with-promptless-p-rs">
<Card title="Interacting with Promptless PRs" icon="brands github" href="/docs/how-to-use-promptless/interacting-with-promptless-p-rs">
Provide follow-up instructions through GitHub PR comments and reviews after your documentation PR is opened.
</Card>

<Card title="Using the Web Interface" icon="regular browser" href="/how-to-use-promptless/using-the-web-interface">
<Card title="Using the Web Interface" icon="regular browser" href="/docs/how-to-use-promptless/using-the-web-interface">
Highlight text, add comments, and provide feedback directly in Promptless's web interface.
</Card>
</CardGroup>
12 changes: 6 additions & 6 deletions fern/docs/features/web-ui-feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ Each suggestion includes a title and description that explains what changes are

### Providing feedback

Promptless offers several ways to provide feedback on suggestions. Learn about all available feedback methods in the [Providing Feedback](/features/providing-feedback) guide.
Promptless offers several ways to provide feedback on suggestions. Learn about all available feedback methods in the [Providing Feedback](/docs/how-to-use-promptless/providing-feedback) guide.

### Triggers page

The Triggers page shows all events that triggered Promptless over the last 30 days. Each entry displays:
The Triggers page shows all events that triggered Promptless to review your documentation over the last 30 days. Each entry displays:

- **Trigger source**: The event that fired (like a GitHub PR or Slack message)
- **Status**: Processing state (completed, in progress, or error)
- **Suggestions created**: Whether documentation updates resulted from this trigger
- **Timestamp**: When the trigger occurred
- **Status**: Whether Promptless completed processing, is still working, or hit an error
- **Suggestions created**: Whether documentation updates were created from this trigger
- **Timestamp**: When the trigger happened

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/triggers-page-dashboard-1759623397.png" alt="Triggers page showing recent trigger events" />
</Frame>

Use the search box to find triggers by PR info, Slack thread topic, task name, or other summary text—including events older than 30 days. Use the filters to narrow down by trigger type or suggestion status. Click any trigger to see full details, including what research Promptless did and why it created (or skipped) documentation updates.
Use the filters at the top to narrow down by trigger type or suggestion status. Click any trigger to see the full details, including what research Promptless did and why it decided to create (or skip) documentation updates.

Need help with the web interface? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai).
Loading
Loading