diff --git a/fern/docs/integrations/bitbucket.mdx b/fern/docs/integrations/bitbucket.mdx index 7bfb7a5..98cb62c 100644 --- a/fern/docs/integrations/bitbucket.mdx +++ b/fern/docs/integrations/bitbucket.mdx @@ -63,28 +63,33 @@ This authentication model ensures that Promptless only has access to the reposit ## Repository Refresh -If you add new repositories to your Bitbucket workspace after setting up the integration, you can refresh the repository list: +After adding new repositories to your Bitbucket workspace, you can choose to update the repository list in Promptless: -1. Go to the **Integrations** page in your Promptless dashboard -2. Find the Bitbucket integration -3. Click the **Refresh Repositories** button to update the list of available repositories +1. Go to the [integrations page](https://app.gopromptless.ai/integrations) +2. Find the Bitbucket integration card +3. Click the "refresh repos" icon (circular arrow) to update the repository list + +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. ## Webhook Management -Promptless automatically sets up webhooks in your Bitbucket repositories to monitor for pull request events. These webhooks: +Promptless automatically sets up webhooks to monitor your pull requests. When changes are detected, Promptless generates documentation updates. + +To view the webhooks: + +1. Go to your Bitbucket workspace settings +2. Navigate to **Webhooks** under **Workspace settings** +3. Look for webhooks created by Promptless -- Trigger Promptless when pull requests are created or updated -- Send only the necessary information about changes to Promptless -- Can be customized to focus on specific events +Need help modifying or troubleshooting webhook behavior? Reach out to [help@gopromptless.ai](mailto:help@gopromptless.ai). ## Usage -Once configured, the Bitbucket integration works similarly to the GitHub integration: +Once configured, the Bitbucket integration works as follows: -1. When a pull request is opened or updated in your monitored repositories, Promptless is automatically triggered -2. Promptless analyzes the changes to determine if documentation updates are needed -3. If updates are needed, Promptless generates the appropriate documentation changes -4. Promptless adds a comment to your Bitbucket pull request with a link to review the documentation changes -5. You can review and approve the suggested documentation updates in the Promptless dashboard +1. When a pull request is opened or updated in your monitored repositories, Promptless analyzes the changes to determine if documentation updates are needed +2. If updates are needed, Promptless creates the documentation changes and stores them in your Promptless dashboard +3. Promptless adds a comment to your Bitbucket pull request with a link to review the changes. You can provide follow-up instructions or approve the changes +4. Approved documentation updates are published to your configured documentation repository For more information on how triggers work in general, see the [Triggers](/docs/core-concepts/triggers) documentation. \ No newline at end of file diff --git a/fern/docs/integrations/index.mdx b/fern/docs/integrations/index.mdx index 6ae0414..6a322fd 100644 --- a/fern/docs/integrations/index.mdx +++ b/fern/docs/integrations/index.mdx @@ -11,7 +11,7 @@ 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 +- [Bitbucket](/docs/integrations/bitbucket): Trigger based on Pull Requests and publish documentation to Bitbucket repos - [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