diff --git a/fern/docs.yml b/fern/docs.yml index b914b3c..3d1379c 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -52,6 +52,12 @@ navigation: contents: - page: Bitbucket Integration path: ./docs/integrations/bitbucket.mdx + - page: ClickUp Integration + path: ./docs/integrations/clickup.mdx + slug: clickup-integration + - page: Document360 Integration + path: ./docs/integrations/document360.mdx + slug: document360-integration - page: GitHub Integration path: ./docs/integrations/github.mdx slug: github-integration @@ -71,8 +77,14 @@ navigation: path: ./docs/integrations/microsoft-teams.mdx - page: Zendesk Integration path: ./docs/integrations/zendesk.mdx + - page: Google Drive Integration (Beta) + path: ./docs/integrations/google-drive.mdx + slug: google-drive-integration - page: Intercom Integration (Beta) path: ./docs/integrations/intercom.md + - page: Notion Integration (Beta) + path: ./docs/integrations/notion.mdx + slug: notion-integration - page: Webflow Integration (Beta) path: ./docs/integrations/webflow.mdx - section: Account Management @@ -145,4 +157,4 @@ typography: style: normal favicon: ./docs/assets/favicon.ico - \ No newline at end of file + diff --git a/fern/docs/integrations/clickup.mdx b/fern/docs/integrations/clickup.mdx new file mode 100644 index 0000000..e83e797 --- /dev/null +++ b/fern/docs/integrations/clickup.mdx @@ -0,0 +1,27 @@ +# ClickUp Integration + +**Used for: Context** + +Promptless integrates with ClickUp to access your project management data for documentation automation. + +## Installation + +1. Click "Connect ClickUp" from the [integrations page](https://app.gopromptless.ai/integrations). +2. You'll be redirected to ClickUp to authorize Promptless to access your workspace. +3. Select the workspace you want to connect and approve the requested permissions. +4. Once authorized, you'll be redirected back to Promptless and can verify that ClickUp is connected. + +## Project Setup and Permissions + +After connecting ClickUp, configure which spaces or lists Promptless can search within when setting up a Project in the [projects page](https://app.gopromptless.ai/projects). Promptless will only search within the spaces you select. + +For example, you can configure Promptless to search only within specific ClickUp spaces for relevant tasks. + +## Authentication Model + +Promptless uses ClickUp's OAuth 2.0 authentication, which provides: + +- Secure token-based authentication +- Workspace-level permissions +- Ability to revoke access at any time +- Granular control over which spaces Promptless can access diff --git a/fern/docs/integrations/document360.mdx b/fern/docs/integrations/document360.mdx new file mode 100644 index 0000000..b418243 --- /dev/null +++ b/fern/docs/integrations/document360.mdx @@ -0,0 +1,40 @@ +# Document360 Integration + +**Used for: Publishing** + +Promptless integrates with Document360, enabling you to publish documentation updates directly to your Document360 knowledge base. + +## Installation + +1. Click "Connect Document360" from the [integrations page](https://app.gopromptless.ai/integrations). + +2. Generate an API token from your Document360 project settings with appropriate permissions for content creation and updates. + +3. Enter your Document360 API token and project details in the Promptless dashboard. + +4. Verify that Document360 is connected in the integrations page. + +## Project Setup and Permissions + +After connecting Document360, configure your publishing settings in the [projects page](https://app.gopromptless.ai/projects). When setting up a project, you can: + +- Select Document360 as your documentation platform +- Choose which categories or sections to publish updates to +- Configure auto-publish settings or review changes before publishing + +## Publishing Updates to Document360 + +When you're ready to publish documentation updates to Document360: + +1. Review your changes in the web interface +2. Approve the changes to publish them to your Document360 knowledge base +3. Updates will be reflected in your Document360 site based on your publishing settings + +## Authentication Model + +Promptless uses Document360's official API with: + +- Secure API token authentication +- Project-level access controls +- Ability to revoke access at any time +- Granular permissions for content management diff --git a/fern/docs/integrations/google-drive.mdx b/fern/docs/integrations/google-drive.mdx new file mode 100644 index 0000000..0647ce2 --- /dev/null +++ b/fern/docs/integrations/google-drive.mdx @@ -0,0 +1,34 @@ +# Google Drive Integration (Beta) + +**Used for: Context** + +Promptless offers beta support for accessing documents in Google Drive to provide additional context for documentation automation. Contact help@gopromptless.ai for access to this integration. + +## Setup + +To set up the Google Drive integration: + +1. Contact us at help@gopromptless.ai to enable the integration for your account +2. Authorize Promptless to access your Google Drive +3. Select which folders or documents Promptless can access for context +4. Configure your settings in the Promptless dashboard + +## How It Works + +When triggered, Promptless can search your authorized Google Drive folders for relevant context like: + +- Design documents +- Product specifications +- Requirements documents +- Meeting notes and other documentation + +This helps Promptless create more accurate and comprehensive documentation updates. + +## Limitations + +As this is a beta feature: +- Only specific document types are supported (Google Docs, PDFs, text files) +- Large folders may require additional configuration +- Access permissions are managed at the folder level + +For any questions or issues with the Google Drive integration, please contact our support team at help@gopromptless.ai. diff --git a/fern/docs/integrations/index.mdx b/fern/docs/integrations/index.mdx index 6ae0414..05cda6e 100644 --- a/fern/docs/integrations/index.mdx +++ b/fern/docs/integrations/index.mdx @@ -12,6 +12,8 @@ Some integrations can be used for multiple purposes. Some integrations are in a ## Available Integrations - [Bitbucket](/docs/integrations/bitbucket-integration): Trigger based on Pull Requests and publish documentation to Bitbucket repos +- [ClickUp](/docs/integrations/clickup-integration): Look up relevant ClickUp tasks and project data for documentation context +- [Document360](/docs/integrations/document360-integration): Publish documentation updates directly to Document360 knowledge base - [GitHub](/docs/integrations/github-integration): Trigger based on Pull Requests, research based on code functionality, and publish documentation to GitHub repos - [GitHub Enterprise](/docs/integrations/github-enterprise-integration): Custom GitHub App configuration for GitHub Enterprise Server and Enterprise Cloud users - [Jira](/docs/integrations/jira-integration): Look up relevant Jira issues and project data using JQL search capabilities when being triggered @@ -22,7 +24,9 @@ Some integrations can be used for multiple purposes. Some integrations are in a ### Beta Integrations +- [Google Drive](/docs/integrations/google-drive-integration): Access documents in Google Drive for additional documentation context (Beta, contact help@gopromptless.ai to get access) - [Intercom](/docs/integrations/intercom-integration-beta): Publish documentation updates directly to Intercom help center (Beta, contact help@gopromptless.ai to get access) +- [Notion](/docs/integrations/notion-integration): Publish documentation updates directly to Notion databases (Beta, contact help@gopromptless.ai to get access) - [Webflow](/docs/integrations/webflow-integration-beta): Publish documentation updates directly to Webflow CMS, including blog posts and collection items (Beta, contact help@gopromptless.ai to get access) ## Security & Authentication diff --git a/fern/docs/integrations/notion.mdx b/fern/docs/integrations/notion.mdx new file mode 100644 index 0000000..75528da --- /dev/null +++ b/fern/docs/integrations/notion.mdx @@ -0,0 +1,31 @@ +# Notion Integration (Beta) + +**Used for: Publishing** + +Promptless offers beta support for publishing documentation directly to Notion databases. Contact help@gopromptless.ai for access to this integration. + +## Setup + +To set up the Notion integration: + +1. Contact us at help@gopromptless.ai to enable the Notion integration +2. Authorize Promptless to access your Notion workspace +3. Select which Notion databases you want to publish documentation to +4. Configure your publishing settings in the Promptless dashboard + +## Publishing Updates to Notion + +When you're ready to publish documentation updates to Notion: + +1. Review your changes in the web interface +2. Approve the changes to publish them to your Notion database +3. Promptless will create or update pages in your selected Notion database + +## Limitations + +As this is a beta feature: +- Some advanced Notion block types might not be fully supported +- Complex formatting should be verified in Notion after publishing +- Database property configurations should match your Notion workspace settings + +For any questions or issues with the Notion integration, please contact our support team at help@gopromptless.ai.