From a01ecb73a8d91d23f7b96fb82f909ce6eb16fe05 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Thu, 8 Jan 2026 16:24:41 +0000 Subject: [PATCH 1/2] Add Doc Collections step to quickstart guide --- fern/docs/getting-started.mdx | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/fern/docs/getting-started.mdx b/fern/docs/getting-started.mdx index edfb17e..8152bed 100644 --- a/fern/docs/getting-started.mdx +++ b/fern/docs/getting-started.mdx @@ -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 @@ -33,7 +34,21 @@ Visit the [Integrations page](https://app.gopromptless.ai/integrations) in your Integrations Page -## 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. + +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.) + +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. @@ -56,6 +71,10 @@ Need both trigger types? Create separate projects with identical settings for ea ### Project Configuration Options + + Select from your existing doc collections to specify where Promptless should publish documentation updates + + Select which Linear teams, Jira projects, or other sources to search for context @@ -83,9 +102,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 From 43c6c46042e382ac09f0cc28655e33d4c347332f Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Thu, 8 Jan 2026 20:58:49 +0000 Subject: [PATCH 2/2] Sync documentation updates --- fern/docs/getting-started.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/fern/docs/getting-started.mdx b/fern/docs/getting-started.mdx index 8152bed..d5eaba0 100644 --- a/fern/docs/getting-started.mdx +++ b/fern/docs/getting-started.mdx @@ -38,6 +38,10 @@ Visit the [Integrations page](https://app.gopromptless.ai/integrations) in your Visit the [Doc Collections page](https://app.gopromptless.ai/doc-collections) and tell Promptless where your documentation lives. + + Doc Collections Page + + Click **+ New Doc Collection** and configure: - **Platform**: Your documentation provider (GitHub, Zendesk, Intercom, Webflow, etc.) @@ -46,6 +50,10 @@ Click **+ New Doc Collection** and configure: - **Include Directories**: Which directories contain your documentation - **Config File**: Path to your config file (for platforms like Fern, Docusaurus, etc.) + + New Doc Collection Modal + + Promptless will analyze and index your docs—this typically takes 5-30 minutes. ## Step 3: Create a project