Setup & Quickstart

Promptless automatically updates your docs, saving your team time and improving your customer experience.

Before You Start

Sign up for a free account at accounts.gopromptless.ai

What permissions are needed?

Connecting integrations may require admin-level access depending on your organization’s settings:

• Slack: Workspace admin permissions to install the Promptless app
• GitHub: Organization admin or sufficient repository access to install the GitHub App
• Jira/Confluence: Atlassian admin permissions to authorize the OAuth connection
• Linear: Workspace admin permissions to connect the integration

Don’t have the required permissions? No problem—you can invite teammates during setup.

Tip

If you don’t have admin access to connect a particular integration, you can invite someone from your IT or Engineering team directly from the onboarding wizard. The invited person receives an email that brings them to the same onboarding page you’re on, and they can pick up exactly where you left off.

Guided Setup Wizard

When you first sign in, a 6-step wizard guides you through setup:

1

Connect Slack

Set up Slack for notifications and to trigger documentation updates via @mentions.

2

Connect docs

Connect your documentation repository (GitHub or other Git providers).

3

Configure triggers

Choose which events trigger documentation updates (GitHub PRs, Slack messages, etc.).

4

Additional context

Optionally connect Linear, Jira, or Confluence for better suggestions.

5

Agent preferences

Configure how Promptless behaves when creating suggestions.

6

Start trial

Begin your 14-day trial.

Your progress saves automatically—if you leave and come back later, you’ll pick up where you left off. Setup doesn’t need to be completed by a single person: any teammate you invite can continue from the current step, making it easy to hand off to someone with the right permissions for a specific integration.

What Gets Configured

During setup, you’ll connect:

Triggers - Events that prompt Promptless to generate documentation suggestions

• GitHub/Bitbucket: Auto-trigger from pull requests
• Slack: Manual triggers via @mentions or message actions

Support Channel: When you connect Slack during setup, we’ll create a shared Slack Connect channel between your team and ours for questions, feedback, and support throughout your trial and beyond.

Documentation Platform - Where your docs live

• GitHub repos: Supports docs-as-code platforms like ReadMe, Mintlify, Fern, Docusaurus, and more

Enhanced Context (optional) - Connect Linear, Jira, Confluence, or Slack to provide Promptless with additional context for better suggestions.

What Happens at Completion

When you finish the setup wizard, Promptless does two things:

1. Indexes your documentation. Promptless ingests your docs repository and learns its structure and content. This takes 5–30 minutes depending on size.

2. Configures triggers and context sources. Promptless generates promptless.yaml entries based on the integrations you connected. Code-change integrations like GitHub, GitLab, or Bitbucket get broad triggers with repos: all, so Promptless listens for PRs and commits across all your repositories. Context integrations like Jira, Confluence, Linear, and Notion get unscoped entries, giving the agent access to all connected data.

Once setup is complete, Promptless:

• Listens for trigger events from your configured sources
• Analyzes changes and gathers relevant context
• Generates documentation suggestions for your review

Your configuration is stored in a promptless.yaml file that you can view and edit anytime in the Configuration page. See the Configuration Reference for the complete schema and how to narrow triggers to specific repositories.

Success

You’re all set! Promptless is now ready to help automate your documentation updates.

Need help with integrations? Contact us at help@gopromptless.ai - we add new integrations every week.