Skip to content

docs: Update getting-started guide to reflect new onboarding wizard #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
prithvi2206 merged 2 commits into from
Jan 15, 2026
Merged

docs: Update getting-started guide to reflect new onboarding wizard #191

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11d5295
Update getting-started guide to reflect new onboarding wizard
promptless[bot] Jan 14, 2026
a3ea234
Sync documentation updates
promptless[bot] Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 34 additions & 63 deletions fern/docs/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,82 +4,53 @@ Promptless automatically updates your docs, saving your team time and improving

## Before You Start

- Contact our team at [hello@gopromptless.ai](mailto:hello@gopromptless.ai) to get invited to Promptless and start a free trial
- Sign up for a free account at [accounts.gopromptless.ai](https://accounts.gopromptless.ai)

## Quick Setup Overview
## Guided Setup Wizard

Get Promptless running in 2 simple steps:
When you first sign in, a 6-step wizard guides you through setup:

1. **Set up integrations** - Set up integrations for triggers, context sources, and documentation platforms
2. **Create a project** - Configure how and when Promptless should update your docs
<Steps>
<Step title="Connect Slack">
Set up Slack for notifications and to trigger documentation updates via @mentions
</Step>

## Step 1: Set up integrations
<Step title="Connect docs">
Connect your documentation platform (GitHub repos, Zendesk, or other supported platforms)
</Step>

Visit the [Integrations page](https://app.gopromptless.ai/integrations) in your dashboard to connect:
<Step title="Configure triggers">
Choose which events trigger documentation updates (GitHub PRs, Slack messages, etc.)
</Step>

**Triggers**
<Step title="Additional context">
Optionally connect Linear, Jira, or Confluence for better suggestions
</Step>

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

**Documentation Platform**

- **GitHub repos**: Most common setup. Supports many hosting providers like ReadMe, Mintlify, Fern, and more.
- **Hosted CMSs**: Zendesk supported today. More coming soon!

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

<Frame>
<img src="./assets/integrations-page.png" alt="Integrations Page" />
</Frame>

## Step 2: Create a project

Visit the [Projects page](https://app.gopromptless.ai/projects) to create your first project.

### Trigger Configuration
<Step title="Agent preferences">
Configure how Promptless behaves when creating suggestions
</Step>

Choose your trigger type:
<Step title="Start trial">
Begin your 30-day trial
</Step>
</Steps>

<Cards>
<Card title="GitHub/Bitbucket Triggers" icon="fa-code-pull-request">
Automatically runs when PRs are opened in specified source repositories.
</Card>
<Card title="Slack Triggers" icon="brands slack">
Runs when you @mention Promptless or use Slack message shortcuts.
</Card>
</Cards>
Your progress saves automatically—if you leave and come back later, you'll pick up where you left off. Team members from the same organization can continue setup without losing previous progress.

<Info>
Need both trigger types? Create separate projects with identical settings for each trigger.
</Info>
## What Gets Configured

### Project Configuration Options

<ParamField path="Context Sources" type="optional">
Select which Linear teams, Jira projects, Confluence spaces, or other sources to search for context
</ParamField>

<ParamField path="Excluded Directories" type="optional">
Specify directories to exclude from analysis (internal docs, deprecated content, etc.)
</ParamField>

<ParamField path="Auto-publish" type="boolean">
Automatically create PRs with documentation changes. Optionally enable auto-merge to automatically merge PRs as soon as they're created.
</ParamField>

<ParamField path="Process Recent PRs" type="boolean">
Analyze PRs from the last 30 days when creating your project to generate suggestions based on recent code changes
</ParamField>

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/80863009-2671-4d86-91d6-95633becce22-new-project-modal-updated.png" alt="Create New Project modal" />
</Frame>
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

**Documentation Platform** - Where your docs live
- **GitHub repos**: Most common setup. Supports many hosting providers like ReadMe, Mintlify, Fern, and more.
- **Hosted CMSs**: Zendesk supported today. More coming soon!

<Tip title="Best Practice">
Create a dedicated Slack channel for documentation update notifications and configure it in your project settings. This helps your team stay coordinated and informed about doc updates.
</Tip>
**Enhanced Context (optional)** - Connect **Linear**, **Jira**, **Confluence**, or **Slack** to provide Promptless with additional context for better suggestions.

## What's Next?

Expand Down