Confluence
Overview
Section titled “Overview”Connect Confluence as a context source so Promptless writes new documentation with the conventions, terminology, and decisions your team already recorded there. While Promptless drafts a suggestion, it searches your Confluence spaces and reads the pages that match, such as:
- Documentation standards for style, terminology, and page structure
- Technical specifications, design decisions, and architecture notes
- Internal processes and guidelines
Confluence access is read-only. Promptless queries Confluence in real time when a documentation task needs it, and doesn’t store your Confluence content. It never creates, updates, or deletes pages.
Example
Section titled “Example”A developer merges a GitHub PR that adds a /v2/exports endpoint to your public API. Your team keeps its API conventions on an “API Guidelines” page in Confluence. That page mandates cursor-based pagination, the limit and starting_after parameter names, and a standard error-envelope format.
When Promptless picks up the merged PR, it searches your Confluence spaces and reads the API Guidelines page. Its suggestion documents the endpoint’s pagination and errors the way every other endpoint in your API reference does. It uses the same parameter names, envelope shape, and structure.
Before you start
Section titled “Before you start”- An admin role in your Promptless organization, to connect Atlassian and edit the Configuration page.
Connect Confluence
Section titled “Connect Confluence”Promptless connects to Confluence through Atlassian. Skip this section if Atlassian is already connected on the Integrations page.
One Atlassian Cloud connection covers Jira, Confluence, or both. You need an admin role in your Promptless organization to connect it. Promptless reads Jira and Confluence with the permissions of the Atlassian account that approves the connection. If you attach an Atlassian service account, Promptless uses it for Jira instead. To connect a dedicated Atlassian account, log in to Atlassian as that account first.
-
On the Promptless Integrations page, select Connect Atlassian.
-
Select Jira, Confluence, or both, and select Continue to Atlassian. Promptless requests only the permissions for the products you select.
-
If Atlassian shows its login screen, log in with the account you want Promptless to use.
-
On the OAuth consent screen, review the permissions Promptless requests. For what each scope is for, see Permissions required.
-
Select Accept. If the consent screen shows no Accept option, your Atlassian account might not have the required permissions. Ask your Jira administrator to connect, or invite them to Promptless.
-
On the Promptless Integrations page, confirm the connection on the Atlassian card.
To manage Promptless’s access later, open Atlassian and go to your avatar > Account settings > Connected apps.
If Confluence searches later fail with a 401 Unauthorized scope error, the connection is missing the Confluence search scopes. Reconnect Atlassian to grant them. See Permissions required.
Limit Promptless to specific spaces
Section titled “Limit Promptless to specific spaces”Promptless can search every space the connected Atlassian account can see. To keep it to the spaces that hold relevant material, scope the Confluence context source:
-
On the Context sources tab of the Configuration page, expand the Confluence source. If it isn’t listed, select Add a context source, and then select Confluence.
-
In Which Confluence spaces should Promptless read?, add the key of each space.
-
Select Save changes. For a new source, select Add context source.
In YAML, the scope is the space_keys list on a confluence entry:
context_sources: confluence: source_type: confluence space_keys: - ENGINEERING - PRODUCTAn entry with no space keys, or no entry, gives Promptless every space the account can see. For every context source field, see the Configuration Reference.
See also
Section titled “See also”- Atlassian integration, for the OAuth scopes Promptless requests and how to connect a dedicated Atlassian account
- Jira, to read the issues behind a change through the same Atlassian connection
- Context sources, to compare every context source Promptless supports