Confluence

Confluence integration provides read-only access to your documentation spaces for documentation automation. When Confluence is configured as a context source, Promptless can search your Confluence spaces for relevant documentation when creating suggestions—but it never modifies your Confluence pages.

How it works as a context source

When Confluence is enabled as a context source:

Automatic Space Searching: Promptless searches your Confluence spaces for relevant documentation when creating suggestions
Documentation Patterns: Confluence pages provide context about existing documentation styles, terminology standards, and content structures
Architectural Context: Technical specifications, design decisions, and system architecture documented in Confluence inform new documentation
Team Knowledge: Internal processes, guidelines, and best practices from your team’s Confluence spaces

Example

Confluence is where teams keep their shared knowledge—the conventions, design decisions, and standards that outlive any single feature. When new code touches an area those pages govern, that space is the source of truth for how the work should be described.

A developer merges a GitHub PR that adds a new /v2/exports endpoint to your public API. Your team keeps its API conventions in a Confluence space—an “API Guidelines” page that 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. Rather than documenting the endpoint in isolation, it describes pagination and errors using the conventions your team already agreed on—the same parameter names, the same envelope shape, the same structure every other endpoint follows. The result is a docs PR that reads like the rest of your API reference instead of a one-off.

Configuration

Configure Confluence scope in your Configuration page using the context_sources section:

context_sources:
  confluence:
    source_type: confluence
    space_keys:
      - ENGINEERING
      - PRODUCT

An empty entry (or no entry) gives Promptless access to all spaces. Add space_keys only when you need to restrict which spaces Promptless can search.

Data privacy

Promptless queries Confluence data in real-time and does not store any of your Confluence data. All searches are performed on-demand when documentation updates are needed. Promptless only reads from Confluence—it never creates, updates, or deletes pages.

Setup instructions

To connect Confluence to Promptless, see the Atlassian Integration setup guide.