From 11d5295de3d2ab6d4f0c79b6bc824e93e9c05ac0 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Wed, 14 Jan 2026 01:14:30 +0000 Subject: [PATCH 1/2] Update getting-started guide to reflect new onboarding wizard --- fern/docs/getting-started.mdx | 95 ++++++++++++----------------------- 1 file changed, 33 insertions(+), 62 deletions(-) diff --git a/fern/docs/getting-started.mdx b/fern/docs/getting-started.mdx index e11efad..8ef98e0 100644 --- a/fern/docs/getting-started.mdx +++ b/fern/docs/getting-started.mdx @@ -6,80 +6,51 @@ Promptless automatically updates your docs, saving your team time and improving - Contact our team at [hello@gopromptless.ai](mailto:hello@gopromptless.ai) to get invited to Promptless and start a free trial -## 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 + + + Set up Slack for notifications and to trigger documentation updates via @mentions + -## Step 1: Set up integrations + + Connect your documentation platform (GitHub repos, Zendesk, or other supported platforms) + -Visit the [Integrations page](https://app.gopromptless.ai/integrations) in your dashboard to connect: + + Choose which events trigger documentation updates (GitHub PRs, Slack messages, etc.) + -**Triggers** + + Optionally connect Linear, Jira, or Confluence for better suggestions + -- **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. - - - Integrations Page - - -## Step 2: Create a project - -Visit the [Projects page](https://app.gopromptless.ai/projects) to create your first project. - -### Trigger Configuration + + Configure how Promptless behaves when creating suggestions + -Choose your trigger type: + + Begin your 30-day trial + + - - - Automatically runs when PRs are opened in specified source repositories. - - - Runs when you @mention Promptless or use Slack message shortcuts. - - +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. - -Need both trigger types? Create separate projects with identical settings for each trigger. - +## What Gets Configured -### Project Configuration Options - - - Select which Linear teams, Jira projects, Confluence spaces, or other sources to search for context - - - - Specify directories to exclude from analysis (internal docs, deprecated content, etc.) - - - - Automatically create PRs with documentation changes. Optionally enable auto-merge to automatically merge PRs as soon as they're created. - - - - Analyze PRs from the last 30 days when creating your project to generate suggestions based on recent code changes - - - - Create New Project modal - +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! - -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. - +**Enhanced Context (optional)** - Connect **Linear**, **Jira**, **Confluence**, or **Slack** to provide Promptless with additional context for better suggestions. ## What's Next? From a3ea2348fce6ee099d2ee4d605bf513dba98fa06 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Thu, 15 Jan 2026 06:13:46 +0000 Subject: [PATCH 2/2] Sync documentation updates --- fern/docs/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs/getting-started.mdx b/fern/docs/getting-started.mdx index 8ef98e0..89234b8 100644 --- a/fern/docs/getting-started.mdx +++ b/fern/docs/getting-started.mdx @@ -4,7 +4,7 @@ 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) ## Guided Setup Wizard