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 five-step wizard guides you through connecting your integrations:

1

Connect chat

Connect Slack or Microsoft Teams for notifications and conversation-based triggers. Skippable.

2

Connect docs

Install the Promptless GitHub App and pick the repos where your documentation lives. This is the only required step—selecting a repo creates your first doc collection automatically, and you can add more doc collections at any time.

3

Connect triggers

Connect source code providers (GitHub, GitLab, Bitbucket) whose changes should trigger documentation updates. Skippable.

4

Connect context

Connect Atlassian (Jira/Confluence), Notion, Linear, or Slite for additional context. Skippable.

5

Review set-up

Optionally book a setup call with our team to ensure your configuration is optimized.

After completing the wizard, Promptless generates a promptless.yaml configuration from the integrations you connected. You can review and edit it anytime on the Configuration page.

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 connected

The setup wizard connects your integrations. You configure them afterward in the app.

Chat - Slack or Microsoft Teams for notifications and @mentions.

Note

Support Channel: When you connect Slack, Promptless creates a shared Slack Connect channel between your team and ours. Check your email to accept the invite—that’s how you reach us during your trial.

Documentation Platform - The GitHub repository where your docs live. Supports docs-as-code platforms like ReadMe, Mintlify, Fern, Docusaurus, Starlight, and more.

Triggers - Git providers (GitHub, GitLab, Bitbucket) as sources for pull request triggers.

Context Sources - Atlassian (Jira/Confluence), Notion, Linear, or Slite to give Promptless 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 from the integrations you connected. Code-change integrations like GitHub, GitLab, or Bitbucket get a broad pull request trigger with repos: all, so Promptless listens for pull requests across all your repositories. Promptless doesn’t seed commit triggers automatically—you can add one anytime from the Configuration page. Context integrations like Jira, Confluence, Linear, Notion, and Google Drive 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.

Tip

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.