Skip to content
Closed
Changes from all commits
Commits
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
37 changes: 31 additions & 6 deletions fern/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ Promptless automatically updates your docs, saving your team time and improving

## Quick Setup Overview

Get Promptless running in 2 simple steps:
Get Promptless running in 3 simple steps:

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
2. **Create a doc collection** - Tell Promptless where your documentation lives
3. **Create a project** - Configure how and when Promptless should update your docs

## Step 1: Set up integrations

Expand All @@ -33,7 +34,29 @@ Visit the [Integrations page](https://app.gopromptless.ai/integrations) in your
<img src="./assets/integrations-page.png" alt="Integrations Page" />
</Frame>

## Step 2: Create a project
## Step 2: Create a doc collection

Visit the [Doc Collections page](https://app.gopromptless.ai/doc-collections) and tell Promptless where your documentation lives.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/doc-collections-page-ed0ad5a2.png" alt="Doc Collections Page" />
</Frame>

Click **+ New Doc Collection** and configure:

- **Platform**: Your documentation provider (GitHub, Zendesk, Intercom, Webflow, etc.)
- **Repository/Location**: Where your docs are hosted
- **Branch**: Default branch for documentation updates
- **Include Directories**: Which directories contain your documentation
- **Config File**: Path to your config file (for platforms like Fern, Docusaurus, etc.)

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/new-doc-collection-modal-742f13f6.png" alt="New Doc Collection Modal" />
</Frame>

Promptless will analyze and index your docs—this typically takes 5-30 minutes.

## Step 3: Create a project

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

Expand All @@ -56,6 +79,10 @@ Need both trigger types? Create separate projects with identical settings for ea

### Project Configuration Options

<ParamField path="Doc Collection" type="required">
Select from your existing doc collections to specify where Promptless should publish documentation updates
</ParamField>

<ParamField path="Context Sources" type="optional">
Select which Linear teams, Jira projects, or other sources to search for context
</ParamField>
Expand Down Expand Up @@ -83,9 +110,7 @@ Create a dedicated Slack channel for documentation update notifications and conf

## What's Next?

After creating a project, Promptless will start ingesting and indexing your documentation. This process helps Promptless learn your documentation structure and content, and remember it for future suggestions. This can take 5-30 minutes, depending on the size of your docs.

Once setup is complete, Promptless will:
Once your doc collection analysis is complete and you've created a project, Promptless will:
- Listen for trigger events from your configured sources
- Analyze changes and gather relevant context
- Generate documentation suggestions for your review
Expand Down