diff --git a/fern/docs.yml b/fern/docs.yml index 0022e04..90fabe7 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -29,19 +29,47 @@ navigation: path: ./docs/index.mdx - page: Setup & Quickstart path: ./docs/getting-started.mdx + - page: Core Concepts + path: ./docs/core-concepts.mdx - page: Pilot Overview hidden: true path: ./docs/pilot-guide.mdx - - section: Core Concepts - icon: fa-regular fa-lightbulb - path: ./docs/core-concepts/index.mdx + - section: Configuring Promptless + icon: fa-regular fa-gear contents: - - page: Triggers - path: ./docs/core-concepts/triggers.md - - page: Context Sources - path: ./docs/core-concepts/context-sources.md - - page: Doc CMSs - path: ./docs/core-concepts/doc-locations.md + - section: Triggers + path: ./docs/configuration/triggers.md + contents: + - page: GitHub PRs + path: ./docs/configuration/triggers/github-prs.md + - page: GitHub Commits + path: ./docs/configuration/triggers/github-commits.md + - page: Slack Messages + 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: + - page: Linear + path: ./docs/configuration/context-sources/linear.md + - page: Jira + path: ./docs/configuration/context-sources/jira.md + - section: Doc Collections + path: ./docs/configuration/doc-collections.md + contents: + - page: GitHub Repos (Docs as Code) + path: ./docs/configuration/doc-collections/github-repos.md + - page: Document360 + path: ./docs/configuration/doc-collections/document360.md + - page: Zendesk + path: ./docs/configuration/doc-collections/zendesk.md + - page: Intercom (Beta) + path: ./docs/configuration/doc-collections/intercom.md + - page: Webflow (Beta) + path: ./docs/configuration/doc-collections/webflow.md - section: How to use Promptless icon: fa-regular fa-star path: ./docs/features/index.mdx @@ -176,4 +204,3 @@ typography: style: normal favicon: ./docs/assets/favicon.ico - diff --git a/fern/docs/configuration/context-sources.md b/fern/docs/configuration/context-sources.md new file mode 100644 index 0000000..dd4e205 --- /dev/null +++ b/fern/docs/configuration/context-sources.md @@ -0,0 +1,69 @@ +--- +title: Context Sources +--- + +Context sources are integrations that connect Promptless to your organization's existing tools and data. They provide additional context that helps Promptless create more accurate and comprehensive documentation suggestions. + +## How Context Sources Work + +Think of context sources as Promptless's way of understanding your team's unique ecosystem. When triggered to create documentation updates, Promptless intelligently searches through your connected tools to gather the most relevant context. This creates documentation that feels like it was written by someone who truly understands your project. + + +Context sources are **optional** but highly recommended. They can significantly improve the quality and relevance of Promptless's documentation suggestions. + + +## Available Context Sources + + + + Access Linear issues, projects, and team workflows for project management context + + + + Query Jira tickets and project data using JQL search capabilities + + + +## Examples + +### Linear as a Context Source + +When a GitHub PR mentions a new feature, Promptless searches Linear for related issues to understand additional project context. This ensures your documentation includes the "why" behind code changes, not just the "what." + +### Jira as a Context Source + +If a GitHub PR references a Jira ticket (like "PROJ-123"), Promptless automatically reads that Jira ticket for additional context. It also proactively searches Jira using JQL for related issues and epics. + +## Configuring Context Sources + +Context sources are configured at the project level in your [projects page](https://app.gopromptless.ai/projects). For each project, you can: + +- Select which context sources to enable +- Configure search scope (e.g., specific teams, projects, or repositories) +- Set permissions for what Promptless can access + +## Data Privacy and Security + +Promptless prioritizes your data privacy and security with context sources: + + + + We do not store any of your organization's data from context sources. Instead, our agents query the relevant APIs in real-time when documentation updates are needed, ensuring that we only access the information required for the specific documentation task at hand. + + + + All context source integrations use: + - OAuth 2.0 authentication + - Encrypted data transmission (TLS 1.2+) + - Granular permission controls + - Token-based access that can be revoked at any time + + + + Promptless only accesses the specific information needed for documentation generation and does not retain or cache this data after processing. + + + +## Requesting Additional Context Sources + +Need integration with other tools? Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to request additional context sources. We're continuously expanding our integration options to better serve your documentation needs. diff --git a/fern/docs/configuration/context-sources/jira.md b/fern/docs/configuration/context-sources/jira.md new file mode 100644 index 0000000..7a93da3 --- /dev/null +++ b/fern/docs/configuration/context-sources/jira.md @@ -0,0 +1,47 @@ +--- +title: Jira +--- + +Jira integration provides access to your project management and issue tracking data for documentation automation. When Jira is configured as a context source, Promptless can search for related tickets to understand requirements and business context. + +## How It Works as Context Source + +When Jira is enabled as a context source: + +- **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 +- **Business Context**: Jira tickets provide requirements, business logic, and feature context that enhance documentation accuracy + +## Example + +If a GitHub PR references a Jira ticket (like "PROJ-123"), Promptless automatically reads that Jira ticket for additional context. It also proactively searches Jira using JQL for related issues and epics. + +## JQL Search Capabilities + +Promptless leverages Jira's powerful JQL (Jira Query Language) search functionality to find relevant context. This allows intelligent searching across your Jira projects to find related issues, epics, and dependencies. + +## Configuration + +Configure Jira context in your [project settings](https://app.gopromptless.ai/projects): + +1. Enable Jira as a context source for your project +2. Select which Jira projects Promptless can search within +3. Promptless will only search projects you explicitly configure + + + Project configuration screen showing context sources setup with Jira integration + + + +Promptless inherits the permissions of the Jira account used during OAuth connection and will only search projects you explicitly configure. + + +## Data Privacy and Security + +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. + +For information about data processing and redaction capabilities, see the Jira integration page. + +## Setup Instructions + +To connect Jira to Promptless, see the [Jira Integration](/docs/integrations/jira-integration) setup guide. diff --git a/fern/docs/configuration/context-sources/linear.md b/fern/docs/configuration/context-sources/linear.md new file mode 100644 index 0000000..e37c0ce --- /dev/null +++ b/fern/docs/configuration/context-sources/linear.md @@ -0,0 +1,41 @@ +--- +title: Linear +--- + +Linear integration provides secure access to your project management data for documentation automation. When Linear is configured as a context source, Promptless can search for related issues to understand the business context behind code changes. + +## How It Works as Context Source + +When Linear is enabled as a context source: + +- **Automatic Issue Lookup**: When a GitHub PR mentions a Linear issue, Promptless automatically retrieves that issue for additional context +- **Proactive Searches**: Promptless can search Linear for related issues and projects to understand feature requirements +- **Business Context**: Linear issues provide the "why" behind code changes, not just the "what" + +## Example + +When a GitHub PR mentions a new feature, Promptless searches Linear for related issues to understand additional project context. This ensures your documentation includes business requirements and feature goals alongside technical implementation details. + +## Configuration + +Configure Linear context in your [project settings](https://app.gopromptless.ai/projects): + +1. Enable Linear as a context source for your project +2. Select which Linear teams Promptless can search within +3. Promptless will only search within teams you explicitly select + + + Project configuration showing Linear team selection + + + +Promptless inherits the permissions of the Linear account used during OAuth connection and will only search teams you configure in your project settings. + + +## Data Privacy + +Promptless queries Linear data in real-time and does not store any of your Linear data. All searches are performed on-demand when documentation updates are needed. + +## Setup Instructions + +To connect Linear to Promptless, see the [Linear Integration](/docs/integrations/linear-integration) setup guide. diff --git a/fern/docs/configuration/doc-collections.md b/fern/docs/configuration/doc-collections.md new file mode 100644 index 0000000..88fb9fb --- /dev/null +++ b/fern/docs/configuration/doc-collections.md @@ -0,0 +1,53 @@ +--- +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, Intercom, and Webflow, you'll need to configure Promptless to read from and publish to your existing docs. + +## Git-hosted Documentation 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: + +- Fern +- Mintlify +- ReadMe (Refactored) +- GitBook +- Docusaurus +- MkDocs +- Hugo +- Ghost +- Nextra +- 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) + +## 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 + +Promptless can publish to multiple documentation locations simultaneously, allowing you to use the same trigger events and context sources across different platforms. + + +For teams using multiple platforms, 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! diff --git a/fern/docs/configuration/doc-collections/document360.md b/fern/docs/configuration/doc-collections/document360.md new file mode 100644 index 0000000..1ae83f5 --- /dev/null +++ b/fern/docs/configuration/doc-collections/document360.md @@ -0,0 +1,49 @@ +--- +title: Document360 +--- + +Document360 integration enables publishing documentation updates directly to your Document360 knowledge base. This is useful for teams who manage customer-facing documentation through Document360's hosted platform. + +## How It Works + +When Document360 is configured as a documentation platform: + +1. **Review Suggestions**: Review documentation changes in the Promptless dashboard +2. **Publish to Document360**: Click "Save All & Update Document360" to publish approved changes +3. **Knowledge Base Updates**: Content is created or updated in your Document360 knowledge base +4. **Live URLs**: Each published article includes a live URL and editor URL for easy access +5. **Customer Access**: Updated articles are immediately available to your customers + +## Publishing Options + +When publishing to Document360, you can: + +- **Create New Articles**: Add new knowledge base articles and help content +- **Update Existing Articles**: Modify existing content with new information +- **Per-file Publishing**: Publish individual files independently for granular control +- **Webhook Sync**: Automatic synchronization with your Document360 projects via webhooks +- **Manage Article Metadata**: Update titles, descriptions, categories, and project organization +- **Add Images**: Include screenshots and diagrams in your knowledge base content + +## Use Cases + +Document360 as a documentation platform is especially useful for: + +- **Customer Knowledge Base**: Maintain help center articles based on product updates and customer feedback +- **Technical Documentation**: Keep API documentation and technical guides up-to-date +- **Internal Documentation**: Manage team wikis and internal process documentation +- **Multi-project Documentation**: Handle documentation for multiple products or services from a single workflow +- **Support Deflection**: Update documentation to reduce recurring support requests + +## Project Setup + +Configure Document360 as your documentation platform in your [project settings](https://app.gopromptless.ai/projects): + +1. Connect your Document360 account +2. Select the project where documentation should be published +3. Configure which categories or sections to publish to +4. Set notification preferences + +## Setup Instructions + +To connect Document360 to Promptless, contact [help@gopromptless.ai](mailto:help@gopromptless.ai) for setup assistance. diff --git a/fern/docs/configuration/doc-collections/github-repos.md b/fern/docs/configuration/doc-collections/github-repos.md new file mode 100644 index 0000000..b1066e1 --- /dev/null +++ b/fern/docs/configuration/doc-collections/github-repos.md @@ -0,0 +1,68 @@ +--- +title: GitHub Repos (Docs as Code) +--- + +The most common documentation setup uses GitHub repositories to store documentation content that syncs to hosting providers. This "docs as code" approach allows you to version control your documentation alongside your code. + +## Supported Platforms + +When your documentation lives in GitHub, Promptless can publish to any of these platforms: + +- **Fern** +- **Mintlify** +- **ReadMe** (Refactored) +- **GitBook** +- **Docusaurus** +- **MkDocs** +- **Hugo** +- **Ghost** +- **Nextra** +- **Vocs** +- **Custom platforms** (as long as the content is in a repo) + +## How It Works + +1. **Repository Setup**: Your documentation files live in a GitHub repository +2. **Promptless Integration**: The Promptless GitHub App has write access to your docs repository +3. **Automatic PRs**: When documentation updates are needed, Promptless creates pull requests in your docs repo +4. **Platform Sync**: Your documentation platform automatically syncs changes from GitHub + +## Project Setup and Permissions + +After setting up the GitHub integration, you'll create a project in the [projects page](https://app.gopromptless.ai/projects). When creating a project, you'll select: + +- **Trigger repositories**: Repositories that initiate documentation updates (read-only access) +- **Documentation repositories**: Repositories where documentation is stored (write access) + + + Project Setup showing trigger and documentation repository selection + + +In the example above, Promptless can read the `promptless` and `promptless-dashboard` repos, but can read and write to the `promptless-docs` repo. + +## Auto-publish Mode + +When auto-publish is enabled for your project: + +- Promptless automatically creates a new PR in your documentation repository with suggested changes +- For GitHub PR triggers, the documentation PR is linked in a comment on the original code PR +- Optionally enable auto-merge to automatically merge documentation PRs as soon as they're created (nested checkbox under auto-publish in project settings) + +## Automated CI Check and Build Issue Resolution + +When Promptless opens a documentation PR, it automatically monitors the pull request for quality issues. If CI checks fail, linting tools report errors, Vale rules trigger warnings, or your documentation hosting provider detects broken links or build problems, Promptless will automatically analyze the issues and push fixes directly to the PR branch. + +This automated issue resolution works seamlessly with your existing GitHub workflow - there's no additional configuration needed. Quality problems get resolved in the background while you focus on content rather than troubleshooting technical issues. + +## Trigger Events in Pull Request Descriptions + +When Promptless creates a pull request for documentation updates, it automatically includes a list of the trigger events that led to those changes in the PR description. This provides valuable context for reviewers and creates clear traceability between documentation updates and their originating events. + +The trigger events section in the PR description includes: +- Links back to the original source (e.g., Slack threads, GitHub PRs, support tickets) +- Brief descriptions of what triggered the documentation update +- Easy navigation to review the context that prompted the changes + +## Setup Instructions + +To connect GitHub to Promptless, see the [GitHub Integration](/docs/integrations/github-integration) setup guide. diff --git a/fern/docs/configuration/doc-collections/intercom.md b/fern/docs/configuration/doc-collections/intercom.md new file mode 100644 index 0000000..907c500 --- /dev/null +++ b/fern/docs/configuration/doc-collections/intercom.md @@ -0,0 +1,52 @@ +--- +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) 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 0000000..d6e004e --- /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) 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 new file mode 100644 index 0000000..f9c5c59 --- /dev/null +++ b/fern/docs/configuration/doc-collections/zendesk.md @@ -0,0 +1,44 @@ +--- +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) setup guide. diff --git a/fern/docs/configuration/triggers.md b/fern/docs/configuration/triggers.md new file mode 100644 index 0000000..3377f26 --- /dev/null +++ b/fern/docs/configuration/triggers.md @@ -0,0 +1,61 @@ +--- +title: Triggers +--- + +Triggers are events that initiate automated documentation updates in Promptless. When a trigger event occurs, Promptless analyzes the context and determines if documentation updates are needed. + +## 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 + + + +## How Triggers Work + +When a trigger event occurs: + +1. **Event Detection**: Promptless receives notification of the event (PR opened, message posted, ticket resolved) +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 + +## Configuring Triggers + +Triggers are configured at the project level in your [projects page](https://app.gopromptless.ai/projects). For each project, you can: + +- Select which trigger types to enable +- Configure trigger-specific settings (e.g., repository filters, channel selections) +- Set up auto-publish behavior for documentation updates +- Define notification preferences for your team + + +Need a trigger type that isn't currently supported? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) - we regularly add new trigger types based on user feedback. + + +## Auto-publish Mode + +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. + +## Trigger Events in Documentation PRs + +When Promptless creates a pull request for documentation updates, it automatically includes a list of the trigger events that led to those changes in the PR description. This provides valuable context for reviewers and creates clear traceability between documentation updates and their originating events. diff --git a/fern/docs/configuration/triggers/github-commits.md b/fern/docs/configuration/triggers/github-commits.md new file mode 100644 index 0000000..cd06868 --- /dev/null +++ b/fern/docs/configuration/triggers/github-commits.md @@ -0,0 +1,47 @@ +--- +title: GitHub Commits +--- + +Promptless can monitor direct commits to your default branches for documentation updates. This is useful for teams that merge changes directly without pull requests, or when you want to capture documentation needs from hotfixes and emergency changes. + +## How It Works + +When a commit is pushed directly to a monitored branch: + +1. **Commit Detection**: Promptless receives notification of the new commit +2. **Analysis**: The system processes the code diff and commit message to understand the changes +3. **Relevance Assessment**: Promptless determines if the changes require documentation updates +4. **Suggestion Creation**: If relevant, Promptless creates documentation suggestions + +## Configuration + +Configure GitHub commit triggers in your [project settings](https://app.gopromptless.ai/projects): + +1. Select GitHub as your trigger source +2. Choose "GitHub Commits" as the trigger type +3. Select which repositories and branches to monitor +4. Optionally configure directory-specific triggers +5. Set auto-publish preferences + + + GitHub commit trigger configuration showing directory options + + +## Directory-Specific Commits + +Similar to PR triggers, you can configure Promptless to only trigger on commits that affect specific directories. This is particularly useful for monitoring changelog directories or specific feature areas. + +When trigger directories are specified, only commits that contain changes to those directories will trigger documentation updates. + +## Use Cases + +GitHub commit triggers are especially useful for: + +- **Changelog Monitoring**: Automatically update documentation when changelog files are modified +- **Hotfix Documentation**: Capture documentation needs from emergency fixes that bypass the normal PR process +- **Direct-to-Main Workflows**: Support teams that commit directly to main branches +- **Automated Updates**: Trigger documentation updates from automated commit processes + +## Setup Instructions + +To connect GitHub to Promptless, see the [GitHub Integration](/docs/integrations/github-integration) setup guide. diff --git a/fern/docs/configuration/triggers/github-prs.md b/fern/docs/configuration/triggers/github-prs.md new file mode 100644 index 0000000..1672e15 --- /dev/null +++ b/fern/docs/configuration/triggers/github-prs.md @@ -0,0 +1,79 @@ +--- +title: GitHub PRs +--- + +Promptless automatically monitors your GitHub repositories for new pull requests. When a PR is opened, the system analyzes the changes to determine if documentation updates are needed. + +## How It Works + +When a pull request is opened in your monitored repositories: + +1. **Automatic Detection**: Promptless receives notification of the new PR +2. **Analysis**: The system processes the code diff, PR title, and PR description to understand the context +3. **Relevance Assessment**: Promptless determines if the changes require documentation updates +4. **Suggestion Creation**: If relevant, Promptless creates documentation suggestions + + +Information from PRs is processed in real-time and not stored by Promptless. The analysis happens only when the PR is created or updated. + + +## Configuration + +Configure GitHub PR triggers in your [project settings](https://app.gopromptless.ai/projects): + +1. Select GitHub as your trigger source +2. Choose which repositories to monitor +3. Optionally configure directory-specific triggers (see below) +4. Set auto-publish preferences + + + GitHub project configuration showing trigger repository selection + + +## Directory-Specific Triggers + +You can configure Promptless to only trigger when changes are made to specific directories within your repositories. This is particularly useful when you want to focus documentation updates on changes to certain parts of your codebase. + +To set up directory-specific triggers: + +1. When creating or editing a project, select the GitHub trigger option +2. Check the "Choose specific directories to trigger this project" option +3. Enter the directory paths you want to monitor, separating multiple paths with commas +4. Save your project configuration + + + Directory-specific GitHub trigger configuration + + +When trigger directories are specified, only PRs that contain changes to those directories will be considered, and updates to other files will be ignored. + +## Repository Topics + +If you have many repositories, you can use GitHub topics to control which ones trigger Promptless. This is especially helpful for organizations with dozens or hundreds of repos where only some need documentation automation. + +1. **Tag your repositories in GitHub**: Add topics to the repositories you want Promptless to monitor (e.g., "docs-watch", "promptless"). To add topics to a repository, go to the repository's main page and click "Add topics" in the About section. + +2. **Configure your project**: When creating or editing a GitHub project, check the "Trigger on repos with certain topics" option and enter the topic(s) you want to monitor. You can specify multiple topics, and Promptless will trigger on any repository that has at least one of those topics. + +3. **Manage through GitHub**: To add a new repository to Promptless, tag it with the configured topic in GitHub. To remove a repository, remove the topic from the repository settings. + + +Learn more about GitHub repository topics in the [GitHub documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). + + +## Auto-publish Mode + +When auto-publish is enabled for your project: +- Promptless automatically creates a new PR in your documentation repository with suggested changes +- The documentation PR is linked in a comment on the original code PR +- Optionally enable auto-merge to automatically merge documentation PRs as soon as they're created + +## Draft Pull Requests + + +Promptless automatically skips draft pull requests. Documentation updates are only triggered when the pull request is marked as ready for review. + + +## Setup Instructions + +To connect GitHub to Promptless, see the [GitHub Integration](/docs/integrations/github-integration) setup guide. diff --git a/fern/docs/configuration/triggers/microsoft-teams.md b/fern/docs/configuration/triggers/microsoft-teams.md new file mode 100644 index 0000000..69c6ccc --- /dev/null +++ b/fern/docs/configuration/triggers/microsoft-teams.md @@ -0,0 +1,44 @@ +--- +title: Microsoft Teams Messages +--- + +Microsoft Teams integration enables automated documentation updates based on team communication and collaboration within your Teams environment. Similar to Slack, you can trigger documentation updates directly from your conversations. + +## Trigger Methods + +### Tag @Promptless in a Channel + +Mention @Promptless in a Teams channel with specific instructions or questions. Promptless will analyze the conversation context to create relevant documentation updates. + +### Send a Direct Message + +Send documentation requests directly to @Promptless in a DM for private documentation requests. + +## How It Works + +When triggered in Microsoft Teams: + +1. **Message Analysis**: Promptless reads the message and conversation context where it was triggered +2. **Context Gathering**: The system analyzes text content and conversation flow +3. **Documentation Suggestions**: Promptless creates suggestions based on the conversation content +4. **Review**: Review and approve suggestions in the Promptless web interface + +## Configuration + +Configure Microsoft Teams triggers in your [project settings](https://app.gopromptless.ai/projects): + +1. Select Microsoft Teams as your trigger source +2. Set auto-publish preferences +3. Configure notification preferences + +## Privacy and Access + +Promptless only reads Microsoft Teams content when you explicitly trigger it by tagging @Promptless in a conversation. The system does not monitor channels passively. + +## Setup Instructions + +To connect Microsoft Teams to Promptless, see the [Microsoft Teams Integration](/docs/integrations/microsoft-teams) 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/slack.md b/fern/docs/configuration/triggers/slack.md new file mode 100644 index 0000000..fc42e0f --- /dev/null +++ b/fern/docs/configuration/triggers/slack.md @@ -0,0 +1,82 @@ +--- +title: Slack Messages +--- + +Slack integration enables documentation updates directly from your team conversations. This is particularly useful for support conversations or internal discussions where questions arise that could be better addressed in your documentation. + +## Trigger Methods + +### Use a Message Action + +Use the Promptless message shortcut on any Slack message to trigger documentation analysis. This method allows you to trigger updates without interrupting the conversation flow. + +### Mention @Promptless in a Channel + +Tag @Promptless in a channel with specific instructions or questions. Promptless will analyze the full thread context to create relevant documentation updates. + +### Send a Direct Message + +Send documentation requests directly to @Promptless in a DM. This is useful for private documentation requests with comprehensive context support. + +## How It Works + +When triggered in Slack: + +1. **Thread Analysis**: Promptless reads the entire thread where it was triggered +2. **Context Gathering**: The system analyzes text, images, and file attachments in the thread +3. **Documentation Suggestions**: Promptless creates suggestions based on the conversation content +4. **Follow-up Editing**: Continue editing suggestions within the same thread using @Promptless mentions + +## Image and File Processing + +Promptless can process images and file attachments shared in Slack threads when triggered, enhancing documentation with visual elements and additional context when appropriate. + +### How It Works + +1. When you tag @Promptless or use the "Update docs" message action in a thread containing images or file attachments, Promptless will analyze both the text and attached files in the thread. + +2. Promptless evaluates whether the images or file content provide valuable context that should be included in the documentation. + +3. If an image or file is deemed relevant, Promptless will: + - Upload the image to a secure S3 bucket + - Extract and incorporate relevant content from file attachments (including images from PDFs) + - Include the image in the documentation updates it suggests + - Format the image appropriately for the documentation platform + +4. When reviewing the suggestion in the Promptless app, you'll see the added images at the bottom of the review interface, allowing you to approve or reject their inclusion. + +## Passive Channel Listening (Optional) + +You can optionally enable passive listening for specific channels. When enabled, Promptless will automatically monitor conversations in your selected channels and create documentation suggestions when threads become inactive. + +To enable passive listening: + +1. Edit your Slack trigger project +2. Check the box for "Listen for all messages in specific channels" +3. Select which channels to monitor +4. Save your configuration + + +Passive listening is completely opt-in and only applies to channels you explicitly select. Promptless cannot access private channels unless it has been specifically invited to those channels. + + +## Configuration + +Configure Slack triggers in your [project settings](https://app.gopromptless.ai/projects): + +1. Select Slack as your trigger source +2. Optionally configure passive listening for specific channels +3. Set auto-publish preferences +4. Configure notification channels + + + Slack project configuration + + +## 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, Promptless will monitor only the specific channels you select in your project configuration. + +## Setup Instructions + +To connect Slack to Promptless, see the [Slack Integration](/docs/integrations/slack-integration) setup guide. diff --git a/fern/docs/configuration/triggers/zendesk.md b/fern/docs/configuration/triggers/zendesk.md new file mode 100644 index 0000000..9dbff1c --- /dev/null +++ b/fern/docs/configuration/triggers/zendesk.md @@ -0,0 +1,40 @@ +--- +title: Zendesk Tickets (Beta) +--- + +Zendesk integration enables automated documentation updates based on support ticket patterns and customer interactions. This helps identify gaps in documentation based on recurring user questions. + +## How It Works + +When a support ticket is resolved: + +1. **Ticket Analysis**: Promptless analyzes the resolved ticket content and customer interaction +2. **Pattern Detection**: The system identifies common questions or issues that might indicate documentation gaps +3. **Context Evaluation**: Promptless determines if the ticket represents a broader documentation need +4. **Suggestion Creation**: If relevant, Promptless creates documentation suggestions to address the gap + +## Configuration + +Configure Zendesk triggers in your [project settings](https://app.gopromptless.ai/projects): + +1. Select Zendesk as your trigger source +2. Configure which ticket types or categories to monitor +3. Set auto-publish preferences +4. Configure notification settings + + +The Zendesk trigger feature is in beta. Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) for more information about enabling this feature for your organization. + + +## Use Cases + +Zendesk triggers are especially useful for: + +- **FAQ Development**: Automatically identify common questions that should be added to documentation +- **Knowledge Base Gaps**: Discover areas where documentation is missing or unclear +- **Customer Pain Points**: Surface recurring issues that need better documentation +- **Support Deflection**: Reduce ticket volume by improving documentation based on actual customer needs + +## Setup Instructions + +To connect Zendesk to Promptless, see the [Zendesk Integration](/docs/integrations/zendesk) setup guide. diff --git a/fern/docs/core-concepts.mdx b/fern/docs/core-concepts.mdx new file mode 100644 index 0000000..ee02201 --- /dev/null +++ b/fern/docs/core-concepts.mdx @@ -0,0 +1,117 @@ +# Core Concepts + +Promptless automates documentation creation and maintenance through three interconnected components that work together to understand your codebase, gather context, and publish updates to your documentation platforms. + +## Overview + +The diagram below illustrates how triggers, context sources, and documentation platforms interact within the Promptless ecosystem: + +```mermaid +graph LR + %% Triggers Section + subgraph "Triggers" + T1[GitHub PR
Slack message
Support ticket] + end + + %% Promptless Core + subgraph "Promptless AI Engine" + AI[Promptless AI Agent] + end + + %% Context Sources Section + subgraph "Context Sources" + C1[Linear Issues
Jira Tickets] + end + + %% Documentation Platforms + subgraph "Documentation Platforms" + D1[Git-hosted docs
Zendesk Help Center
Intercom, Webflow] + end + + %% Connections + T1 --> AI + + AI -.-> C1 + + AI --> D1 + + %% Styling + 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 + + class T1 triggerStyle + class C1 contextStyle + class AI coreStyle + class D1 cmsStyle +``` + +## How the Components Work Together + +### 1. Triggers Initiate the Process + +**Triggers** are the starting point for all documentation updates. They monitor various sources for events that might require documentation changes: + +- **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/configuration/triggers). + +### 2. Context Sources Enrich Promptless's Understanding + +**Context Sources** enhance the AI's understanding by providing real-time access to your organization's data: + +- **Project Management**: Linear issues and Jira tickets provide business context and feature requirements +- **Code Repository**: GitHub integration gives deep understanding of your codebase structure and recent changes +- **Historical Data**: Past documentation patterns and team workflows inform better suggestions + + +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). + +### 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, 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). + +## Key Benefits of This Architecture + + + + Triggers automatically detect when documentation updates are needed, eliminating manual monitoring + + + + Context sources provide the AI with deep understanding of your organization's specific needs and terminology + + + + Support for multiple documentation platforms means you can maintain consistency across all your docs + + + + No data storage means fresh, up-to-date information is always used for documentation generation + + + +## Advanced Configuration + +For enterprise deployments, you can customize how these components interact: + +- **Directory-specific Triggers**: Monitor only specific parts of your codebase +- **Team-scoped Context**: Limit context sources to specific teams or projects +- **Multi-environment Publishing**: Separate staging and production documentation workflows +- **Custom Integration Patterns**: Self-hosted deployments support custom trigger and publishing workflows + + +Need help designing your documentation automation workflow? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) for personalized setup guidance. + diff --git a/fern/docs/core-concepts/_category_.json b/fern/docs/core-concepts/_category_.json index f4fa3c1..e69de29 100644 --- a/fern/docs/core-concepts/_category_.json +++ b/fern/docs/core-concepts/_category_.json @@ -1,8 +0,0 @@ -{ - "label": "Core Concepts", - "position": 1, - "link": { - "type": "generated-index", - "description": "Core concepts of Promptless" - } -} \ No newline at end of file diff --git a/fern/docs/core-concepts/context-sources.md b/fern/docs/core-concepts/context-sources.md index 3e02424..e69de29 100644 --- a/fern/docs/core-concepts/context-sources.md +++ b/fern/docs/core-concepts/context-sources.md @@ -1,99 +0,0 @@ -# Context Sources - -Context sources are integrations that connect Promptless to your organization's existing tools and data. They often contain important information that can augment the trigger events. - -## How Context Sources Work - -Think of context sources as Promptless's way of understanding your team's unique ecosystem. When triggered to create documentation updates, Promptless intelligently searches through your connected tools to gather the most relevant context. This creates documentation that feels like it was written by someone who truly understands your project. - - -Context sources are **optional** but highly recommended. They can improve the quality and relevance of Promptless's documentation suggestions. - - -## 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 Slack conversations and threads for team discussions and decisions - - - - Analyze code repositories, issues, and pull request discussions for technical context - - - -### Linear as a Context Source - -When a GitHub PR mentions a new feature, Promptless searches Linear for related issues to understand additional project context. This ensures your documentation includes the "why" behind code changes, not just the "what." - -### Jira as a Context Source - -If a GitHub PR references a Jira ticket (like "PROJ-123"), Promptless automatically reads that Jira ticket for additional context. It also proactively search Jira using JQL for related issues and epics. - -### Slack as a Context Source - -For example, when documenting a new API endpoint, Promptless can search Slack for previous discussions among team members to incorporate decisions, edge cases, or common questions. - - -Slack can serve as both a trigger source and context source. - - -### GitHub as a Context Source - -In addition to code diffs from trigger PRs, Promptless finds related GitHub issues and PR comments when you set GitHub as a context source. - -## Configuration and Setup - -Context sources are configured at the project level: - - - - Visit the [Integrations page](https://app.gopromptless.ai/integrations) to connect your context sources using OAuth 2.0 authentication. - - - - In your [project settings](https://app.gopromptless.ai/projects), select which context sources to enable and configure their search scope. - - - - Define which teams, projects, or repositories Promptless can search within each context source. - - - - - Project configuration showing context sources selection - - -## Data Privacy and Security - -Promptless prioritizes your data privacy and security with context sources: - - - - We do not store any of your organization's data from context sources. Instead, our agents query the relevant APIs in real-time when documentation updates are needed, ensuring that we only access the information required for the specific documentation task at hand. - - - - All context source integrations use: - - OAuth 2.0 authentication - - Encrypted data transmission (TLS 1.2+) - - Granular permission controls - - Token-based access that can be revoked at any time - - - - Promptless only accesses the specific information needed for documentation generation and does not retain or cache this data after processing. - - - -## Requesting Additional Context Sources - -Need integration with other tools? Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) to request additional context sources. We're continuously expanding our integration options to better serve your documentation needs. \ No newline at end of file diff --git a/fern/docs/core-concepts/doc-locations.md b/fern/docs/core-concepts/doc-locations.md index 8cf9c62..e69de29 100644 --- a/fern/docs/core-concepts/doc-locations.md +++ b/fern/docs/core-concepts/doc-locations.md @@ -1,50 +0,0 @@ -# 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. - -## GitHub-Synced Documentation Platforms - -The most common setup uses the **Promptless GitHub App** to integrate with documentation platforms that sync content from GitHub repositories. A list of platforms supported by the github integration: -- Fern -- Mintlify -- Readme (Refactored) -- Gitbook -- Docusaurus -- Mkdocs -- Hugo -- Ghost -- Nextra -- Vocs -- Custom CMS 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 - -For teams using content management systems that don't sync with GitHub, Promptless offers direct integrations with popular CMS 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 - -Promptless can publish to multiple documentation locations simultaneously, allowing you to use the same trigger events and context sources across different platforms. - - -For teams using multiple platforms, 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. Feel free to 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! \ No newline at end of file diff --git a/fern/docs/core-concepts/index.mdx b/fern/docs/core-concepts/index.mdx index da80810..e69de29 100644 --- a/fern/docs/core-concepts/index.mdx +++ b/fern/docs/core-concepts/index.mdx @@ -1,126 +0,0 @@ -# Core Concepts - -Promptless automates documentation creation and maintenance through three interconnected components that work together to understand your codebase, gather context, and publish updates to your documentation platforms. - -## Overview - -The diagram below illustrates how triggers, context sources, and documentation CMSs interact within the Promptless ecosystem: - -```mermaid -graph TB - %% Triggers Section - subgraph "Triggers" - T1[GitHub/Bitbucket/GitLab
Pull Requests] - T2[Slack & Microsoft Teams
Messages & Mentions] - T3[Zendesk
Support Tickets] - end - - %% Context Sources Section (vertical layout) - subgraph "Context Sources" - direction TB - C1[Linear Issues
& Projects] - C2[Jira Tickets
& Workflows] - C3[GitHub Code
& Repository Data] - end - - %% Promptless Core - subgraph "Promptless AI Engine" - AI[Promptless AI Agent] - end - - %% Documentation CMSs - subgraph "Documentation CMSs" - D1[GitHub-synced Docs
ReadMe, Mintlify, Docusaurus] - D2[Zendesk
Help Center] - D3[Intercom
Help Center] - D4[Webflow
CMS & Blog] - end - - %% Connections - T1 --> AI - T2 --> AI - T3 --> AI - - C1 -.-> AI - C2 -.-> AI - C3 -.-> AI - - AI --> D1 - AI --> D2 - AI --> D3 - AI --> D4 - - %% Styling - 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 - - class T1,T2,T3 triggerStyle - class C1,C2,C3 contextStyle - class AI coreStyle - class D1,D2,D3,D4 cmsStyle -``` - -## How the Components Work Together - -### 1. Triggers Initiate the Process - -**Triggers** are the starting point for all documentation updates. They monitor various sources for events that might require documentation changes: - -- **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 - -### 2. Context Sources Enrich Promptless's Understanding - -**Context Sources** enhance the AI's understanding by providing real-time access to your organization's data: - -- **Project Management**: Linear issues and Jira tickets provide business context and feature requirements -- **Code Repository**: GitHub integration gives deep understanding of your codebase structure and recent changes -- **Historical Data**: Past documentation patterns and team workflows inform better suggestions - - -Context sources are queried in real-time and no customer data is stored by Promptless, ensuring your sensitive information remains secure. - - -### 3. Documentation CMSs Receive Updates - -**Documentation CMSs** 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 -- **Multi-platform Publishing**: Single trigger can update multiple documentation platforms simultaneously - -## Key Benefits of This Architecture - - - - Triggers automatically detect when documentation updates are needed, eliminating manual monitoring - - - - Context sources provide the AI with deep understanding of your organization's specific needs and terminology - - - - Support for multiple documentation platforms means you can maintain consistency across all your docs - - - - No data storage means fresh, up-to-date information is always used for documentation generation - - - -## Advanced Configuration - -For enterprise deployments, you can customize how these components interact: - -- **Directory-specific Triggers**: Monitor only specific parts of your codebase -- **Team-scoped Context**: Limit context sources to specific teams or projects -- **Multi-environment Publishing**: Separate staging and production documentation workflows -- **Custom Integration Patterns**: Self-hosted deployments support custom trigger and publishing workflows - - -Need help designing your documentation automation workflow? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) for personalized setup guidance. - \ No newline at end of file diff --git a/fern/docs/core-concepts/triggers.md b/fern/docs/core-concepts/triggers.md index f993fc0..e69de29 100644 --- a/fern/docs/core-concepts/triggers.md +++ b/fern/docs/core-concepts/triggers.md @@ -1,59 +0,0 @@ -# Triggers - -Triggers are events that initiate automated documentation updates in Promptless. - -## Supported Triggers - - - - Automatically triggered when PRs/MRs are opened in your source repositories - - - - Trigger updates from Slack conversations and support threads - - - -### GitHub / Bitbucket / GitLab - -Promptless automatically monitors your specified source repositories for new pull requests. When a PR/MR is opened, the system analyzes the changes to determine if documentation updates are needed. - -During analysis, Promptless processes information such as the code diff, PR title, and PR description to understand the context and scope of changes. This information is used solely for generating documentation suggestions and is not stored by Promptless. - -You can configure specific directories to monitor, focusing documentation efforts on relevant parts of your codebase. - -#### What Gets Analyzed - -When a PR triggers Promptless, we only analyze the files that changed in that PR. We don't search your entire repository—just the specific files shown in the diff. - -This focused approach means Promptless understands exactly what's changing and generates accurate documentation updates based on those specific changes. - - - - When auto-publish is enabled for your project: - - Promptless automatically creates a new PR in your documentation repository with suggested changes - - For GitHub PR triggers, the documentation PR is linked in a comment on the original code PR - - Optionally enable auto-merge to automatically merge documentation PRs as soon as they're created (nested checkbox under auto-publish in project settings) - - - - -Promptless automatically skips draft pull requests. Documentation updates are only triggered when the pull request is marked as ready for review. - - -### Slack Integration - -Slack integration enables documentation updates directly from your team conversations. This is particularly useful for support conversations or internal discussions where questions arise that could be better addressed in your documentation. - -**Trigger methods:** -- **Message Action**: Use the Promptless message shortcut on any Slack message to trigger documentation analysis -- **Mentions**: Tag @Promptless in a channel to request documentation updates based on the conversation context -- **Passive Listening** (optional): Enable automatic monitoring of specific channels for hands-free documentation updates. You can configure it in product-releases channel, or customer-support channels. - -#### Image Processing in Slack Threads - -When triggered in threads containing images, Promptless analyzes both text and visual content. Relevant images are automatically included in documentation updates, securely stored, and formatted for your documentation platform. - - -Need a trigger type that isn't currently supported? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) - we regularly add new trigger types based on user feedback. - \ No newline at end of file diff --git a/fern/docs/integrations/github.mdx b/fern/docs/integrations/github.mdx index 13977a3..cd7ab88 100644 --- a/fern/docs/integrations/github.mdx +++ b/fern/docs/integrations/github.mdx @@ -63,84 +63,36 @@ After the initial installation, you may need to add new repositories or modify w After updating repository access, the new repositories will be available when creating or editing projects in Promptless. Note that it may take a few minutes for the changes to be reflected in the Promptless dashboard. If you don't see newly added repositories immediately, you may need to click the "refresh repos" icon in the integrations page to update the repository list. -## Project Setup and Permissions - -After setting up the integration, you'll be able to create a project in the [projects page](https://app.gopromptless.ai/projects). When creating a project, you'll be able to select trigger repositories and documentation repositories. Promptless will have read-only access to the repositories that you select as trigger repositories, and will have write access to the repositories that you select as documentation repositories. - -For example, in the below example, Promptless is only able to read the `promptless` and `promptless-dashboard` repos, but is able to read and write to the `promptless-docs` repo. - - - Project Setup - - -## Triggering Promptless on Repository Topics - -If you have a lot of repositories, you can use GitHub topics to control which ones trigger Promptless. This is especially helpful for organizations with dozens or hundreds of repos where only some need documentation automation. Once you set it up, teams can add their repositories to Promptless just by tagging them in GitHub—no need to update your Promptless project configuration. - -1. **Tag your repositories in GitHub**: Add topics to the repositories you want Promptless to monitor. You can use topics like "docs-watch", "promptless", or any other topic that makes sense for your organization. To add topics to a repository, go to the repository's main page and click "Add topics" in the About section. - -2. **Configure your Promptless project**: When creating or editing a GitHub project, check the "Trigger on repos with certain topics" option and enter the topic(s) you want to monitor. You can specify multiple topics, and Promptless will trigger on any repository that has at least one of those topics. - -3. **Manage repositories through GitHub**: To add a new repository to Promptless, tag it with the configured topic in GitHub. To remove a repository, remove the topic from the repository settings. - - -Learn more about GitHub repository topics in the [GitHub documentation](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics). - - -## Trigger Events in Pull Request Descriptions - -When Promptless creates a pull request for documentation updates, it automatically includes a list of the trigger events that led to those changes in the PR description. This provides valuable context for reviewers and creates clear traceability between documentation updates and their originating events. - -The trigger events section in the PR description includes: -- Links back to the original source (e.g., Slack threads, GitHub PRs, support tickets) -- Brief descriptions of what triggered the documentation update -- Easy navigation to review the context that prompted the changes - -This feature helps you understand why documentation changes were made and provides a clear audit trail for all updates. - -## Directory-Specific Triggers - -You can configure Promptless to only trigger when changes are made to specific directories within your repositories. This is particularly useful when you want to focus documentation updates on changes to certain parts of your codebase, such as changelog directories. - -To set up directory-specific triggers: - -1. When creating or editing a project, select the GitHub trigger option -2. Check the "Choose specific directories to trigger this project" option -3. Enter the directory paths you want to monitor, separating multiple paths with commas -4. Save your project configuration - - - Directory-specific GitHub trigger configuration - - -Once configured, your specified trigger directories will be visible in the project list view, making it easy to see which directories are being monitored for each project. - -When trigger directories are specified, only PRs that contain changes to those directories will be considered, and updates to other files will be ignored. - -## Automated CI Check and Build Issue Resolution - -When Promptless opens a documentation PR, it automatically monitors the pull request for quality issues. If CI checks fail, linting tools report errors, Vale rules trigger warnings, or your documentation hosting provider detects broken links or build problems, Promptless will automatically analyze the issues and push fixes directly to the PR branch. - -This automated issue resolution works seamlessly with your existing GitHub workflow - there's no additional configuration needed. Quality problems get resolved in the background while you focus on content rather than troubleshooting technical issues. - ## Authentication Model Promptless uses the official [GitHub App specification](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps) to authenticate with GitHub. Promptless authenticates securely with JWTs generated by the GitHub App installation. This ensures that Promptless has read and write access to the repositories that you select, and that either you or Promptless can revoke access at any time. -## Frequently Asked Questions -### How do I add more repositories after installing the GitHub integration? +## What You Can Do with GitHub -Add additional repositories anytime by visiting your GitHub organization settings. In GitHub, head to `Settings -> Third-party Access -> GitHub Apps` then find the Promptless GitHub App and click "Configure." Add or remove repositories in the "Repository access" section, then click "Save." You'll be able to choose from the newly added repositories when creating or editing your Promptless projects. +Once connected, you can use GitHub for: -### Can I remove GitHub repository access from Promptless? +- **[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 + +## Frequently Asked Questions -You can remove access to specific repositories or even uninstall the integration entirely from the same "Configure" page in your GitHub organization settings. Click the `×` next to a repository name to remove it from the Promptless GitHub App, or click the `Uninstall` button at the bottom of the page to remove the app entirely. + + + Add additional repositories anytime by visiting your GitHub organization settings. In GitHub, head to `Settings -> Third-party Access -> GitHub Apps` then find the Promptless GitHub App and click "Configure." Add or remove repositories in the "Repository access" section, then click "Save." You'll be able to choose from the newly added repositories when creating or editing your Promptless projects. + -### How long does it take for repository changes to appear in Promptless? + + You can remove access to specific repositories or even uninstall the integration entirely from the same "Configure" page in your GitHub organization settings. Click the `×` next to a repository name to remove it from the Promptless GitHub App, or click the `Uninstall` button at the bottom of the page to remove the app entirely. + -It may take a few minutes for repository updates in the GitHub App to be reflected in your Promptless dashboard. If you don't see newly added repositories right away when creating or editing projects, click the "refresh repos" icon in the integrations page. -### Can I connect multiple GitHub organizations to one Promptless account? + + It may take a few minutes for repository updates in the GitHub App to be reflected in your Promptless dashboard. If you don't see newly added repositories right away when creating or editing projects, click the "refresh repos" icon in the integrations page. + -Yes. After connecting your first GitHub organization, you can add more by clicking "Connect another GitHub Org" on the integrations page. Each organization appears as its own card, and repositories from all connected organizations are available when setting up projects. \ No newline at end of file + + Yes. After connecting your first GitHub organization, you can add more by clicking "Connect another GitHub Org" on the integrations page. Each organization appears as its own card, and repositories from all connected organizations are available when setting up projects. + + diff --git a/fern/docs/integrations/intercom.md b/fern/docs/integrations/intercom.md index 24c26e3..146505b 100644 --- a/fern/docs/integrations/intercom.md +++ b/fern/docs/integrations/intercom.md @@ -1,33 +1,27 @@ # 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 hello@gopromptless.ai to enable the Intercom integration for your account +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 -## Publishing Updates to Intercom - -When you're ready to publish documentation updates to Intercom: - -1. Review your changes in the Change History page -2. Click the "Save All & Update Intercom" button -3. Promptless will create or update drafts in your Intercom help center -4. Review and publish the drafts in Intercom when ready - -:::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. -::: +## What You Can Do with Intercom -## Limitations +Once connected, you can use Intercom as a [documentation platform](/docs/configuration/doc-collections/intercom) to publish help center articles and customer support documentation. -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 + +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. \ No newline at end of file +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/jira.mdx b/fern/docs/integrations/jira.mdx index bea1a86..5cc34c1 100644 --- a/fern/docs/integrations/jira.mdx +++ b/fern/docs/integrations/jira.mdx @@ -58,29 +58,9 @@ After connecting, manage Promptless access by going to your avatar > Account set Atlassian Connected Apps Management -## Project Setup and Permissions +## What You Can Do with Jira -After connecting Jira, configure which projects you'd like Promptless to search in your [project settings](https://app.gopromptless.ai/projects). Promptless inherits the permissions of the Jira account used during OAuth connection and will only search projects you explicitly configure. - - - 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. - +Once connected, you can use Jira as a [context source](/docs/configuration/context-sources/jira) to automatically retrieve ticket information and search for related issues using JQL queries. ## Provisioning a Jira Account for Promptless @@ -105,7 +85,7 @@ Create the account using an email alias like `your_email+promptless@company.com` - 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. + When accepting the invite, make sure you're logged out of your personal account, and logged into the Jira account you created for Promptless, otherwise this won't work. @@ -124,10 +104,11 @@ Create the account using an email alias like `your_email+promptless@company.com` Promptless Bot account showing as ACTIVE in user list - ---- +## 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. ## Troubleshooting @@ -148,59 +129,4 @@ Create the account using an email alias like `your_email+promptless@company.com` - 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 bd35bca..04f12a7 100644 --- a/fern/docs/integrations/linear.mdx +++ b/fern/docs/integrations/linear.mdx @@ -19,22 +19,11 @@ Promptless integrates with Linear through OAuth 2.0, providing secure access to Linear Organization Selection - 3. Once you're signed in, you'll be redirected back to Promptless, and you can verify that Linear is connected. Linear Integration Complete -## Project Setup and Permissions - -After connecting Linear, you can configure which teams you'd like Promptless to search within when setting up a Project in the [projects page](https://app.gopromptless.ai/projects). Promptless will not be able to search within teams that you do not select. - -For example, in the below example project, Promptless will only search within the `PRO` team for relevant issues. - - - Project Setup - - ## Authentication Model Promptless uses OAuth 2.0 to authenticate with Linear, following their [official Linear OAuth 2.0 specification](https://developers.linear.app/docs/oauth/authentication). This ensures: @@ -44,3 +33,6 @@ Promptless uses OAuth 2.0 to authenticate with Linear, following their [official - Granular permission control at the team level - Regular token rotation for enhanced security +## 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. diff --git a/fern/docs/integrations/microsoft-teams.mdx b/fern/docs/integrations/microsoft-teams.mdx index f32abe8..ce5dc38 100644 --- a/fern/docs/integrations/microsoft-teams.mdx +++ b/fern/docs/integrations/microsoft-teams.mdx @@ -40,7 +40,7 @@ First, download the Promptless Teams app package from the [Promptless integratio Teams Upload Custom App Dialog -### Step 3: Grant access to users in the organization +### Step 3: Grant Access to Users 1. In the left navigation, select **Setup policies** @@ -56,29 +56,13 @@ First, download the Promptless Teams app package from the [Promptless integratio Global Policy -### Step 4: Add Promptless App +5. Search for "Promptless" and add it to the policy +6. Click **Save** to apply the changes -1. After selecting Promptless, click **Select** to add it to your organization's approved apps +## What You Can Do with Microsoft Teams - - Add App - - -2. Verify that Promptless appears in your installed apps list. Now your organization's users can interact directly with Promptless bot - - - Teams Promptless Installed - - -## Project Setup and Permissions - -After installing the Teams app, you can configure new projects in the [projects page](https://app.gopromptless.ai/projects) to be set up to trigger from Microsoft Teams. - -## Support and Troubleshooting +Once connected, you can use Microsoft Teams for: -If you encounter issues during installation or setup: +- **[Triggers](/docs/configuration/triggers/microsoft-teams)**: Tag @Promptless in channels or DMs to trigger documentation updates -1. Verify that your organization allows third-party app installations -2. Ensure you have the necessary admin permissions in Teams admin center -3. Check that app setup policies are configured correctly -4. Contact [help@gopromptless.ai](mailto:help@gopromptless.ai) for additional support \ No newline at end of file +For more details about configuration, see [Microsoft Teams Triggers](/docs/configuration/triggers/microsoft-teams). diff --git a/fern/docs/integrations/slack.mdx b/fern/docs/integrations/slack.mdx index 7523bab..01afd52 100644 --- a/fern/docs/integrations/slack.mdx +++ b/fern/docs/integrations/slack.mdx @@ -1,6 +1,6 @@ # Slack Integration -**Used for: Triggers** +**Used for: Triggers and Context** Promptless integrates with Slack through our official Slack App, enabling automated documentation updates based on team communication and support conversations. @@ -30,111 +30,15 @@ Promptless integrates with Slack through our official Slack App, enabling automa Slack Integration Complete -## Project Setup and Permissions +## What You Can Do with Slack -After installing the Slack app, you can configure new projects in the [projects page](https://app.gopromptless.ai/projects) to be set up to trigger from Slack. +Once connected, you can use Slack for: -Below is an example of a project that is set up to trigger from Slack. +- **[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 - - Slack Project Setup - - -Once the Project is created, you will be able to trigger Promptless by writing @Promptless in a Slack channel, or by clicking Slack "Update Docs" message action on any thread. When you perform either of these actions, Promptless will pull the entire thread it was tagged in, and identify the right documentation updates based on the contents of that thread. - -### Optional: Passive Channel Listening - -You can optionally enable passive listening for specific channels. When enabled, Promptless will automatically monitor conversations in your selected channels and create documentation suggestions when threads become inactive. - -To enable passive listening: -1. Edit your Slack trigger project -2. Check the box for "Listen for all messages in specific channels" -3. Select which channels to monitor -4. Save your configuration - -Passive listening is completely opt-in and only applies to channels you explicitly select. For more details, see [Working with Slack](/docs/features/slack-interactions#4-passive-channel-listening). - - - 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, Promptless will monitor only the specific channels you select in your project configuration. Promptless cannot access private channels unless it has been specifically invited to those channels. - - -## Image and File Attachment Processing - -Promptless can process images and file attachments shared in Slack threads when triggered, enhancing documentation with visual elements and additional context when appropriate. - -### How It Works - -1. When you tag @Promptless or use the "Update docs" message action in a thread containing images or file attachments, Promptless will analyze both the text and attached files in the thread. - -2. Promptless evaluates whether the images or file content provide valuable context that should be included in the documentation. - -3. If an image or file is deemed relevant, Promptless will: - - Upload the image to a secure S3 bucket managed by Promptless - - Extract and incorporate relevant content from file attachments (including images from PDFs) - - Include the image in the documentation updates it suggests - - Format the image appropriately for the documentation platform - -4. When reviewing the suggestion in the Promptless app, you'll see the added images at the bottom of the review interface, allowing you to approve or reject their inclusion. - -For practical examples of using images and file attachments when triggering Promptless, see [Working with Slack](/docs/features/slack-interactions). - - - Image Processing in Slack Threads - - -### Managing Images - -After images have been added to your documentation, you can manage them through the Promptless dashboard: - -1. Navigate to the Change History page for the specific documentation update -2. Scroll to the Created Assets section at the bottom of the page -3. From here, you can: - - View a preview of each image - - Edit an image by clicking on it to open the screenshot editor (crop, add annotations, shapes, text, arrows) - - Copy the URL of an image to use elsewhere - - Delete an image if it's no longer needed - -**Important:** When you delete an image, it's permanently removed from both the database and storage. If the image is referenced in any documentation, you'll need to manually update that content to remove or replace the reference to the deleted image. - -### Permission Requirements - -This feature requires additional Slack permissions to access images in threads. If you installed the Slack app before this feature was released, you'll need to reinstall it: - -1. Go to the [integrations page](https://app.gopromptless.ai/integrations) -2. Delete the existing Slack integration -3. Re-add the Slack app to grant the new permissions - -**Note:** File attachment processing supports images, PDFs, and other common file types directly shared in Slack threads, including files from external links. - -## Permission Scope and Usage - -### What Promptless Actually Does - -By default, Promptless operates on an **explicit trigger model** with Slack: - -- **Only reads content when triggered**: Promptless only accesses Slack messages when you explicitly tag @Promptless or use the "Update Docs" message action -- **Thread-based processing**: When triggered, Promptless reads the entire thread to understand context, but only for that specific thread -- **No background monitoring by default**: Unless you enable passive listening for specific channels, Promptless does not scan, monitor, or automatically read messages in any channels - -If you enable **passive channel listening** (optional): -- **Selective monitoring**: Promptless will monitor only the specific channels you explicitly select in your project configuration -- **Automatic suggestions**: When threads become inactive, Promptless analyzes the conversation and creates documentation suggestions when appropriate -- **Full control**: You can add or remove channels from passive listening at any time - -### Why Broader Permissions Are Requested - -The Slack app requests broader permissions than currently used to support potential future features: - -- **Future search capabilities**: We've designed the permission scope to potentially allow searching across Slack threads for relevant context (similar to searching through documentation) -- **Customer-requested features**: Some customers have specifically asked for the ability to search historical Slack conversations for documentation context -- **Optional future functionality**: If we add these features, they would be **opt-in configuration options** that you control - -## Authentication Model - -Promptless uses Slack's [official App authentication](https://api.slack.com/authentication), which provides: +## Privacy and Channel Access -- Secure OAuth 2.0 token-based authentication -- Granular permission scopes -- Ability to revoke access at the workspace or channel level -- Regular token rotation for enhanced security +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). diff --git a/fern/docs/integrations/webflow.mdx b/fern/docs/integrations/webflow.mdx index 247399d..b683c27 100644 --- a/fern/docs/integrations/webflow.mdx +++ b/fern/docs/integrations/webflow.mdx @@ -2,79 +2,21 @@ **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 for access to this integration. +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 hello@gopromptless.ai to enable the Webflow integration for your account +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 -## Publishing Updates to Webflow - -When you're ready to publish documentation updates to Webflow: - -1. Review your changes in the Change History page -2. Click the "Save All & Update Webflow" button -3. Promptless will create or update content in your Webflow CMS -4. Content will be automatically published to your live site (if auto-publish is enabled) - -## Blog Post Management - -Promptless can help you manage your Webflow blog posts by: - -- **Creating new blog 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 - -### Creating a New Blog Post - -To create a new blog post through Promptless: - -1. Trigger a documentation update (via Slack, GitHub PR, or other configured triggers) -2. Promptless will analyze the content and suggest creating a new blog post if appropriate -3. Review the suggested content in your Promptless dashboard -4. Approve the changes to publish the new post to your Webflow site - -### Example: Adding a Joke Page - -If you want to add a lighthearted page with a joke to your blog, you can: - -1. Mention @Promptless in Slack with your request -2. Promptless will create a new blog post with your joke content -3. The post will include proper formatting, metadata, and be ready for publication -4. Review and approve the content before it goes live - -## 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 - -## 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 - ## Authentication Model Promptless uses Webflow's [official API](https://developers.webflow.com/) with: @@ -84,4 +26,8 @@ Promptless uses Webflow's [official API](https://developers.webflow.com/) with: - Ability to revoke access at any time - Granular permissions for different content types -For any questions or issues with the Webflow integration, please contact our support team at help@gopromptless.ai. \ No newline at end of file +## What You Can Do with Webflow + +Once connected, you can use Webflow as a [documentation platform](/docs/configuration/doc-collections/webflow) 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 95bcee1..7d27abe 100644 --- a/fern/docs/integrations/zendesk.mdx +++ b/fern/docs/integrations/zendesk.mdx @@ -2,7 +2,7 @@ **Used for: Triggers and Publishing** -Promptless integrates with Zendesk through OAuth 2.0, enabling automated documentation updates based on support ticket patterns and customer interactions, as well as enabling publishing of updates to Zendesk's CMS (Help Center). +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. ## Installation @@ -15,13 +15,6 @@ Promptless integrates with Zendesk through OAuth 2.0, enabling automated documen 3. Verify that Zendesk is connected in the integrations page. -## Project Setup and Permissions - -After connecting Zendesk, you can configure ticket monitoring settings in the [projects page](https://app.gopromptless.ai/projects). When setting up a project, you can: - -- Set up a Zendesk trigger so that Promptless will be notified when a ticket is resolved -- Set up a publishing project so that Promptless will publish updates to the Zendesk Help Center - ## Authentication Model Promptless uses Zendesk's [official OAuth 2.0 authentication](https://developer.zendesk.com/api-reference/introduction/security-and-auth/), which provides: @@ -29,4 +22,11 @@ Promptless uses Zendesk's [official OAuth 2.0 authentication](https://developer. - Secure token-based authentication - Granular API access scopes - Ability to revoke access at any time -- Regular token rotation for enhanced security \ No newline at end of file +- Regular token rotation for enhanced security + +## What You Can Do with Zendesk + +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