diff --git a/fern/docs/configuration/context-sources.md b/fern/docs/configuration/context-sources.md index dc8bf6a1..a9f00433 100644 --- a/fern/docs/configuration/context-sources.md +++ b/fern/docs/configuration/context-sources.md @@ -15,15 +15,15 @@ Context sources are **optional** but highly recommended. They can significantly ## Available Context Sources - + Access Linear issues, projects, and team workflows for project management context - + Query Jira tickets and project data using JQL search capabilities - + Search Confluence spaces for existing documentation patterns, terminology, and architectural decisions diff --git a/fern/docs/configuration/doc-collections.md b/fern/docs/configuration/doc-collections.md index ca38b4b4..8f5cc09d 100644 --- a/fern/docs/configuration/doc-collections.md +++ b/fern/docs/configuration/doc-collections.md @@ -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 @@ -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. - + Help center articles and knowledge base content management - + Customer support documentation and help center content + + + Blog posts, collection items, and marketing site content + ## Multi-Platform Publishing diff --git a/fern/docs/configuration/doc-collections/intercom.md b/fern/docs/configuration/doc-collections/intercom.md index 907c5008..97e54eb3 100644 --- a/fern/docs/configuration/doc-collections/intercom.md +++ b/fern/docs/configuration/doc-collections/intercom.md @@ -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. Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Intercom integration for your account. diff --git a/fern/docs/configuration/doc-collections/webflow.md b/fern/docs/configuration/doc-collections/webflow.md new file mode 100644 index 00000000..4b5d22b2 --- /dev/null +++ b/fern/docs/configuration/doc-collections/webflow.md @@ -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. + + +Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Webflow integration for your account. + diff --git a/fern/docs/configuration/doc-collections/zendesk.md b/fern/docs/configuration/doc-collections/zendesk.md index f9c5c59c..5d7782c5 100644 --- a/fern/docs/configuration/doc-collections/zendesk.md +++ b/fern/docs/configuration/doc-collections/zendesk.md @@ -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. diff --git a/fern/docs/configuration/triggers.md b/fern/docs/configuration/triggers.md index 3bcc09bb..fb9eec5f 100644 --- a/fern/docs/configuration/triggers.md +++ b/fern/docs/configuration/triggers.md @@ -7,23 +7,23 @@ Triggers are events that initiate automated documentation updates in Promptless. ## Available Trigger Types - + Automatically triggered when pull requests are opened in your GitHub repositories - + Monitor direct commits to default branches for documentation updates - + Trigger updates from Slack conversations and support threads - + Trigger updates from Microsoft Teams messages and mentions - + Monitor support tickets for documentation gaps based on recurring user questions @@ -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. diff --git a/fern/docs/configuration/triggers/microsoft-teams.md b/fern/docs/configuration/triggers/microsoft-teams.md index 69c6ccce..edac583b 100644 --- a/fern/docs/configuration/triggers/microsoft-teams.md +++ b/fern/docs/configuration/triggers/microsoft-teams.md @@ -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. Microsoft Teams integration requires admin center access to install the Promptless Teams app. See the setup guide for detailed installation instructions. diff --git a/fern/docs/configuration/triggers/zendesk.md b/fern/docs/configuration/triggers/zendesk.md index 9dbff1c3..accebe95 100644 --- a/fern/docs/configuration/triggers/zendesk.md +++ b/fern/docs/configuration/triggers/zendesk.md @@ -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. diff --git a/fern/docs/core-concepts.mdx b/fern/docs/core-concepts.mdx index ae0c94d1..b72288b0 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
Zendesk Help Center
Intercom, Webflow] end %% Connections @@ -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 @@ -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. -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 diff --git a/fern/docs/faq.mdx b/fern/docs/faq.mdx index 678aeb66..09827aca 100644 --- a/fern/docs/faq.mdx +++ b/fern/docs/faq.mdx @@ -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 @@ -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). @@ -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? diff --git a/fern/docs/features/index.mdx b/fern/docs/features/index.mdx index cadc5315..024945a4 100644 --- a/fern/docs/features/index.mdx +++ b/fern/docs/features/index.mdx @@ -8,15 +8,15 @@ Promptless offers multiple ways to interact with the platform and generate docum ## Interaction Methods - + Use message actions, DMs, and channel mentions to trigger documentation updates and follow-up edits directly from Slack conversations. - + Provide follow-up instructions through GitHub PR comments and reviews after your documentation PR is opened. - + Highlight text, add comments, and provide feedback directly in Promptless's web interface. diff --git a/fern/docs/features/web-ui-feedback.mdx b/fern/docs/features/web-ui-feedback.mdx index 205841f0..9f5d65ae 100644 --- a/fern/docs/features/web-ui-feedback.mdx +++ b/fern/docs/features/web-ui-feedback.mdx @@ -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 Triggers page showing recent trigger events -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). diff --git a/fern/docs/index.mdx b/fern/docs/index.mdx index 3d8feb86..97e23d15 100644 --- a/fern/docs/index.mdx +++ b/fern/docs/index.mdx @@ -45,15 +45,15 @@ graph LR ``` - + Monitor your development ecosystem for events that indicate documentation needs—from pull requests and code changes to team discussions and support tickets. - + 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. @@ -78,10 +78,42 @@ graph LR +## Who Uses Promptless + +Promptless automatically detects when code changes require documentation updates and notifies your team through your existing workflows. + +### Development Teams + +When you open a PR, Promptless automatically checks if docs need updating and notifies your team in Slack. + + + Slack notification from Promptless bot showing documentation updates detected + + +Promptless drafts the initial update based on your PR changes, so you can review and publish without switching between tools. + +### Technical Writers + +Promptless automatically detects doc-impacting PRs and sends notifications to your Slack channels, so you stay informed without monitoring a hundred release channels or attending every standup. + + + Promptless notification showing GitHub PR detected with documentation updates + + +When reviewing suggestions, all the context you need—PR details, related conversations, issue tickets—is available directly in the web interface. + + + Web interface showing citation panel with GitHub PR context and research details + + + +Ready to get started? Promptless integrates with your existing tools and workflows to provide immediate value without disrupting your team's productivity. + + ## Next Steps - + Get Promptless running with your repositories and communication tools in under 10 minutes. diff --git a/fern/docs/integrations/atlassian.mdx b/fern/docs/integrations/atlassian.mdx index ac12a203..5f0a4b64 100644 --- a/fern/docs/integrations/atlassian.mdx +++ b/fern/docs/integrations/atlassian.mdx @@ -53,7 +53,7 @@ For Atlassian Cloud-hosted Jira instances: - Click "Accept" and verify the connection in Promptless. If you don't see the option to accept, you may not have the required permissions. Contact your Jira administrator or invite them to Promptless. For more information about adding new members, see our [Account Management](/docs/managing-accounts) page. + Click "Accept" and verify the connection in Promptless. If you don't see the option to accept, you may not have the required permissions. Contact your Jira administrator or invite them to Promptless. For more information about adding new members, see our [Account Management](/docs/account-management) page. @@ -66,8 +66,8 @@ After connecting, manage Promptless access by going to your avatar > Account set Once connected, you can use Jira and Confluence as context sources to enhance documentation suggestions: -- **Jira**: Automatically retrieve ticket information and search for related issues using JQL queries. See the [Jira Context Source](/docs/configuration/context-sources/jira) page for details. -- **Confluence**: Search your Confluence spaces for existing documentation patterns, terminology, and architectural decisions. See the [Confluence Context Source](/docs/configuration/context-sources/confluence) page for details. +- **Jira**: Automatically retrieve ticket information and search for related issues using JQL queries. See the [Jira Context Source](/docs/context-sources/jira) page for details. +- **Confluence**: Search your Confluence spaces for existing documentation patterns, terminology, and architectural decisions. See the [Confluence Context Source](/docs/context-sources/confluence) page for details. Atlassian integration showing both Jira projects and Confluence spaces in a unified interface @@ -119,7 +119,7 @@ Create the account using an email alias like `your_email+promptless@company.com` ## Data Processing and Security -For information about how Promptless processes Jira data, including redaction capabilities and privacy controls, see the [Jira Context Source](/docs/configuration/context-sources/jira) page. +For information about how Promptless processes Jira data, including redaction capabilities and privacy controls, see the [Jira Context Source](/docs/context-sources/jira) page. ## Troubleshooting diff --git a/fern/docs/integrations/bitbucket.mdx b/fern/docs/integrations/bitbucket.mdx index 57dad15d..a1ffd205 100644 --- a/fern/docs/integrations/bitbucket.mdx +++ b/fern/docs/integrations/bitbucket.mdx @@ -89,4 +89,4 @@ Once configured, the Bitbucket integration works similarly to the GitHub integra 4. Promptless adds a comment to your Bitbucket pull request with a link to review the documentation changes 5. You can review and approve the suggested documentation updates in the Promptless dashboard -For more information on how triggers work in general, see the [Triggers](/docs/core-concepts/triggers) documentation. \ No newline at end of file +For more information on how triggers work in general, see the [Triggers](/docs/triggers) documentation. \ No newline at end of file diff --git a/fern/docs/integrations/github-enterprise.mdx b/fern/docs/integrations/github-enterprise.mdx index f6b99b54..58a3e882 100644 --- a/fern/docs/integrations/github-enterprise.mdx +++ b/fern/docs/integrations/github-enterprise.mdx @@ -11,7 +11,7 @@ This setup is required for GitHub Enterprise Server instances and GitHub Enterpr ## Prerequisites - GitHub Enterprise admin access to create and configure GitHub Apps -- Network access to Promptless endpoints (see [IP whitelisting](#ip-whitelisting) section) +- Network access to Promptless endpoints (see [IP whitelisting](#step-6-ip-whitelisting) section) - Ability to generate and securely store private keys and client secrets ## Step 1: Register New GitHub App diff --git a/fern/docs/integrations/github.mdx b/fern/docs/integrations/github.mdx index cd7ab888..7820be02 100644 --- a/fern/docs/integrations/github.mdx +++ b/fern/docs/integrations/github.mdx @@ -73,9 +73,9 @@ This ensures that Promptless has read and write access to the repositories that Once connected, you can use GitHub for: -- **[Triggers](/docs/configuration/triggers)**: Monitor pull requests and commits for documentation updates -- **[Context Sources](/docs/configuration/context-sources/github)**: Search code repositories and issues for technical context -- **[Doc Collections](/docs/configuration/doc-collections/github-repos)**: Publish documentation updates to GitHub-based platforms +- **[Triggers](/docs/triggers)**: Monitor pull requests and commits for documentation updates +- **Context**: GitHub repositories and issues are automatically searched for technical context +- **[Doc Collections](/docs/doc-collections/git-hub-repos-docs-as-code)**: Publish documentation updates to GitHub-based platforms ## Frequently Asked Questions diff --git a/fern/docs/integrations/intercom.md b/fern/docs/integrations/intercom.md index 146505b4..8cc0eace 100644 --- a/fern/docs/integrations/intercom.md +++ b/fern/docs/integrations/intercom.md @@ -18,7 +18,7 @@ To set up the Intercom integration: ## What You Can Do with Intercom -Once connected, you can use Intercom as a [documentation platform](/docs/configuration/doc-collections/intercom) to publish help center articles and customer support documentation. +Once connected, you can use Intercom as a [documentation platform](/docs/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. diff --git a/fern/docs/integrations/jira.mdx b/fern/docs/integrations/jira.mdx new file mode 100644 index 00000000..60c1a61d --- /dev/null +++ b/fern/docs/integrations/jira.mdx @@ -0,0 +1,196 @@ +# Jira Integration + +**Used for: Context** + + +If you have Jira integration set up, when engineers reference Jira issue keys in GitHub PRs or commit messages (like "PROJ-123"), Promptless can automatically retrieve important context from the tickets to make its suggestions more accurate. + + +Promptless integrates with both Jira Cloud and Jira Data Center instances. + +## Integration Types + +Promptless supports two types of Jira integrations depending on your Jira deployment: + + + + For Atlassian-hosted Jira instances. Uses OAuth 2.0 authentication through Atlassian's secure connection process. + + + For self-hosted Jira Data Center installations. Uses username and password authentication with your organization's instance. + + + + +Jira Data Center is in Beta. Please contact the Promptless team at [help@gopromptless.ai](mailto:help@gopromptless.ai) to connect your Jira Data Center instance to Promptless. + + +## Jira Cloud Installation + +For Atlassian Cloud-hosted Jira instances: + + + + Click "Connect Jira Cloud" from the [integrations page](https://app.gopromptless.ai/integrations). + + + + If you're not already logged in, you'll see the Atlassian login screen: + + Atlassian Login Screen + + + + + Review the permissions Promptless is requesting on the OAuth consent screen: + + Jira OAuth Consent Screen + + + + + Click "Accept" and verify the connection in Promptless. If you don't see the option to accept, you may not have the required permissions. Contact your Jira administrator or invite them to Promptless. For more information about adding new members, see our [Account Management](/docs/account-management) page. + + + +After connecting, manage Promptless access by going to your avatar > Account settings > Connected apps in Atlassian: + + Atlassian Connected Apps Management + + +## Project Setup and Permissions + +After connecting Jira, you can configure which projects you'd like Promptless to search in when setting up a Project in the [projects page](https://app.gopromptless.ai/projects). Promptless will not search projects not specified here. + + + Project configuration screen showing context sources setup with Jira integration + + + + Jira context configuration interface showing connected status and accessible projects + + +## JQL Search Capabilities + +Promptless leverages Jira's powerful JQL (Jira Query Language) search functionality to find relevant context: + +- **Automatic Issue Retrieval**: When a GitHub PR or other trigger mentions a Jira ticket (like "PROJ-123"), Promptless automatically retrieves that specific issue for additional context. + +- **Proactive JQL Searches**: Promptless can proactively search Jira using JQL queries to find related issues, epics, and project data that might be relevant to the documentation being generated. + + +Promptless queries Jira data in real-time and does not store any of your Jira data. All searches are performed on-demand when documentation updates are needed. + + +## Provisioning a Jira Account for Promptless + +We recommend creating a dedicated Jira account for Promptless so that Promptless can create Jira issues and you can track its work in your project management system. + +Create the account using an email alias like `your_email+promptless@company.com`, or ask your IT admin to provision a new email account like `promptless@company.com`. + + + + In Atlassian, go to your settings and select **User management** under Atlassian admin settings. + + + Atlassian admin settings showing User management option + + + + + Click "Invite people" and enter the email address for your Promptless account. Under the Jira app, select the **User** role (not User access admin). + + + Invite people to Jira screen with email and User role selected + + + + When accepting the invite, make sure you're logged out of your person account, and logged into the Jira account you created for Promptless, otherwise this won't work. + + + + + Check your own email inbox (if you're using the alias), or Promptless's email inbox. + + + Email invitation from Jira to join the team + + + When setting up the account, you can use the name "Promptless Bot". + + Once complete, you'll see the account listed as ACTIVE. It might take up to an hour for the status to update from INVITED to ACTIVE after you accept the invite. + + + Promptless Bot account showing as ACTIVE in user list + + + + + +--- + +## Troubleshooting + + + + - Disconnect Jira from the [integrations page](https://app.gopromptless.ai/integrations) + - Sign out of your personal Jira account in your browser + - Sign in to the Promptless bot account you created + - Reconnect Jira to Promptless while signed in to the bot account + + + + - Ensure you have admin permissions in your Jira instance + - Check that your organization allows OAuth 2.0 applications + - Verify you're not using a restricted Jira account + - Contact your Jira administrator to grant the necessary permissions + + + + - Verify Jira is connected on the [integrations page](https://app.gopromptless.ai/integrations) + - Check that your browser isn't blocking the connection (look for errors in the console) + - Disconnect and reconnect Jira + - Refresh the project configuration page + + + + - Verify you have access to those projects in Jira itself + - Check that the projects aren't archived or restricted + - Ensure the account used for OAuth has the correct project permissions + - Re-authenticate with an account that has broader project access + + + + - Verify the Jira project key matches exactly (case-sensitive) + - Check that the project is configured in your Promptless project's context sources + - Ensure the ticket exists and is accessible with your Jira permissions + - Confirm the ticket isn't in a project that's excluded from your configuration + + + + You need to configure which projects Promptless should search: + - Go to the [projects page](https://app.gopromptless.ai/projects) and select your project + - Click on Context Sources and select your Jira integration + - Choose which Jira projects Promptless should search + + + + - Check the email inbox for the Promptless Bot account and ensure you accepted the invite + - Verify you were signed in to the Promptless Bot account (not your personal account) when accepting + - It can take up to an hour for status to update after accepting the invitation + - If status doesn't update after an hour, re-invite the account + + + + OAuth tokens can expire or be revoked. To reconnect: + - Visit the [integrations page](https://app.gopromptless.ai/integrations) + - Delete and reconnect your Jira integration + - Ensure you're signed in to the correct Jira account during reconnection + + + + Jira Data Center integration is currently in Beta. Contact the Promptless team at [help@gopromptless.ai](mailto:help@gopromptless.ai) and we'll work with you directly to set up your Data Center connection. + + + +For additional support, contact [help@gopromptless.ai](mailto:help@gopromptless.ai). diff --git a/fern/docs/integrations/linear.mdx b/fern/docs/integrations/linear.mdx index 04f12a7b..a181293f 100644 --- a/fern/docs/integrations/linear.mdx +++ b/fern/docs/integrations/linear.mdx @@ -35,4 +35,4 @@ Promptless uses OAuth 2.0 to authenticate with Linear, following their [official ## What You Can Do with Linear -Once connected, you can use Linear as a [context source](/docs/configuration/context-sources/linear) to search for related issues and project management data that enhances documentation accuracy. +Once connected, you can use Linear as a [context source](/docs/context-sources/linear) to search for related issues and project management data that enhances documentation accuracy. diff --git a/fern/docs/integrations/microsoft-teams.mdx b/fern/docs/integrations/microsoft-teams.mdx index ce5dc386..8fd19d15 100644 --- a/fern/docs/integrations/microsoft-teams.mdx +++ b/fern/docs/integrations/microsoft-teams.mdx @@ -63,6 +63,6 @@ First, download the Promptless Teams app package from the [Promptless integratio Once connected, you can use Microsoft Teams for: -- **[Triggers](/docs/configuration/triggers/microsoft-teams)**: Tag @Promptless in channels or DMs to trigger documentation updates +- **[Triggers](/docs/triggers/microsoft-teams-messages)**: Tag @Promptless in channels or DMs to trigger documentation updates -For more details about configuration, see [Microsoft Teams Triggers](/docs/configuration/triggers/microsoft-teams). +For more details about configuration, see [Microsoft Teams Triggers](/docs/triggers/microsoft-teams-messages). diff --git a/fern/docs/integrations/slack.mdx b/fern/docs/integrations/slack.mdx index 7c60c699..20f95e4c 100644 --- a/fern/docs/integrations/slack.mdx +++ b/fern/docs/integrations/slack.mdx @@ -4,10 +4,6 @@ Promptless integrates with Slack through our official Slack App, enabling automated documentation updates based on team communication and support conversations. -Promptless does not archive or store your Slack messages. - -Disclaimer: Promptless uses LLMs from OpenAI and Anthropic that have the potential to generate inaccurate results. - ## Installation 1. Click "Connect Slack" from the [integrations page](https://app.gopromptless.ai/integrations). @@ -26,7 +22,7 @@ Disclaimer: Promptless uses LLMs from OpenAI and Anthropic that have the potenti - By default, Promptless only accesses Slack content when you explicitly trigger it by tagging @Promptless or using the "Update Docs" message action. If you enable passive listening, Promptless monitors only the specific channels you select. + Promptless requests broader permissions than it currently uses to support potential future features like searching across Slack threads for relevant context. Currently, Promptless only accesses threads when you explicitly tag @Promptless or use the "Update Docs" message action. Promptless does not actively monitor or read any channels. 4. Verify that Slack is connected in the integrations page. @@ -38,11 +34,10 @@ Disclaimer: Promptless uses LLMs from OpenAI and Anthropic that have the potenti Once connected, you can use Slack for: -- **[Triggers](/docs/configuration/triggers/slack)**: Tag @Promptless or use message actions to trigger documentation updates -- **[Context Sources](/docs/configuration/context-sources/slack)**: Search Slack conversations for team discussions and decisions +- **[Triggers](/docs/triggers/slack-messages)**: Tag @Promptless or use message actions to trigger documentation updates ## Privacy and Channel Access By default, Promptless only reads Slack content when you explicitly trigger it by tagging @Promptless or using the "Update Docs" message action. If you enable passive listening in your project settings, Promptless will monitor only the specific channels you select. Promptless cannot access private channels unless it has been specifically invited to those channels. -For more details about using Slack with Promptless, see [Working with Slack](/docs/features/slack-interactions). +For more details about using Slack with Promptless, see [Working with Slack](/docs/how-to-use-promptless/working-with-slack). diff --git a/fern/docs/integrations/webflow.mdx b/fern/docs/integrations/webflow.mdx new file mode 100644 index 00000000..a44a44e4 --- /dev/null +++ b/fern/docs/integrations/webflow.mdx @@ -0,0 +1,33 @@ +# Webflow Integration (Beta) + +**Used for: Publishing** + +Promptless offers beta support for updating content directly in Webflow CMS. This integration allows you to manage your Webflow blog posts, collection items, and other CMS content through the Promptless platform. + + +Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Webflow integration for your account. + + +## Setup + +To set up the Webflow integration: + +1. Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) to enable the Webflow integration for your account +2. Generate a Webflow API token from your Webflow project settings +3. Configure your Webflow credentials in the Promptless dashboard +4. Select Webflow as your documentation platform when creating a new project + +## Authentication Model + +Promptless uses Webflow's [official API](https://developers.webflow.com/) with: + +- Secure API token authentication +- Site-specific access controls +- Ability to revoke access at any time +- Granular permissions for different content types + +## What You Can Do with Webflow + +Once connected, you can use Webflow as a [documentation platform](/docs/doc-collections/webflow-beta) to publish blog posts, collection items, and other CMS content. + +For any questions or issues with the Webflow 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 7d27abe9..87fe99f9 100644 --- a/fern/docs/integrations/zendesk.mdx +++ b/fern/docs/integrations/zendesk.mdx @@ -28,5 +28,5 @@ Promptless uses Zendesk's [official OAuth 2.0 authentication](https://developer. Once connected, you can use Zendesk for: -- **[Triggers](/docs/configuration/triggers/zendesk)**: Monitor resolved support tickets for documentation gaps (Beta) -- **[Doc Collections](/docs/configuration/doc-collections/zendesk)**: Publish documentation updates directly to your Zendesk Help Center +- **[Triggers](/docs/triggers/zendesk-tickets-beta)**: Monitor resolved support tickets for documentation gaps (Beta) +- **[Doc Collections](/docs/doc-collections/zendesk)**: Publish documentation updates directly to your Zendesk Help Center diff --git a/fern/docs/pilot-guide.mdx b/fern/docs/pilot-guide.mdx index 68fe26b1..94801076 100644 --- a/fern/docs/pilot-guide.mdx +++ b/fern/docs/pilot-guide.mdx @@ -77,7 +77,7 @@ We always recommend kicking off customer pilots with an in-person workshop. - Review your configuration and how [triggers](/docs/core-concepts/triggers), [context sources](/docs/core-concepts/context-sources), and [documentation platforms](/docs/core-concepts/doc-c-m-ss) work for your team + Review your configuration and how [triggers](/docs/triggers), [context sources](/docs/context-sources), and [doc collections](/docs/doc-collections) work for your team Review suggestions together and publish documentation updates during the session diff --git a/fern/docs/security-and-privacy/privacy-policy.md b/fern/docs/security-and-privacy/privacy-policy.md index 51c5f13f..db7e02e2 100644 --- a/fern/docs/security-and-privacy/privacy-policy.md +++ b/fern/docs/security-and-privacy/privacy-policy.md @@ -13,7 +13,7 @@ Our privacy policy covers important aspects of data handling, including: ## Complete Privacy Policy For the complete, current version of our privacy policy, please visit: -[Promptless Privacy Policy](https://www.gopromptless.ai/privacy) +[Promptless Privacy Policy](https://promptless.ai/privacy) ## Privacy Inquiries