From d20342bb0d0a372912a4b89cc59ad2073d50bc1f Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 13 Feb 2026 17:50:33 +0000 Subject: [PATCH 1/5] Add 3 new Use Case pages --- fern/docs.yml | 39 ++++++++---------- fern/docs/use-cases/engineering-teams.mdx | 50 +++++++++++++++++++++++ fern/docs/use-cases/index.mdx | 20 +++++++++ fern/docs/use-cases/support-to-docs.mdx | 48 ++++++++++++++++++++++ fern/docs/use-cases/technical-writers.mdx | 44 ++++++++++++++++++++ 5 files changed, 180 insertions(+), 21 deletions(-) create mode 100644 fern/docs/use-cases/engineering-teams.mdx create mode 100644 fern/docs/use-cases/index.mdx create mode 100644 fern/docs/use-cases/support-to-docs.mdx create mode 100644 fern/docs/use-cases/technical-writers.mdx diff --git a/fern/docs.yml b/fern/docs.yml index 66bd90e8..a9dba41f 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -1,8 +1,6 @@ instances: - url: promptless.docs.buildwithfern.com - custom-domain: - - docs.gopromptless.ai - - docs.promptless.ai + custom-domain: docs.gopromptless.ai title: Promptless | Documentation @@ -36,11 +34,6 @@ navigation: path: ./docs/getting-started.mdx - page: Core Concepts path: ./docs/core-concepts.mdx - - page: Promptless for Open-Source - slug: promptless-oss - path: ./docs/open-source.mdx - - page: Getting Help - path: ./docs/getting-help.mdx - page: Pilot Overview hidden: true path: ./docs/pilot-guide.mdx @@ -74,10 +67,14 @@ navigation: contents: - page: GitHub Repos (Docs as Code) path: ./docs/configuration/doc-collections/github-repos.md + - page: Document360 + path: ./docs/configuration/doc-collections/document360.md - page: Zendesk path: ./docs/configuration/doc-collections/zendesk.md - page: Intercom (Beta) path: ./docs/configuration/doc-collections/intercom.md + - page: Webflow (Beta) + path: ./docs/configuration/doc-collections/webflow.md - section: How to use Promptless icon: fa-regular fa-star path: ./docs/features/index.mdx @@ -90,6 +87,16 @@ navigation: path: ./docs/features/web-ui-feedback.mdx - page: Providing Feedback path: ./docs/features/providing-feedback.mdx + - section: Use Cases + icon: fa-regular fa-lightbulb + path: ./docs/use-cases/index.mdx + contents: + - page: For Engineering Teams + path: ./docs/use-cases/engineering-teams.mdx + - page: For Technical Writers + path: ./docs/use-cases/technical-writers.mdx + - page: Support Tickets to Docs + path: ./docs/use-cases/support-to-docs.mdx - section: Integrations icon: fa-regular fa-plug path: ./docs/integrations/index.mdx @@ -117,6 +124,8 @@ navigation: path: ./docs/integrations/zendesk.mdx - page: Intercom Integration (Beta) path: ./docs/integrations/intercom.md + - page: Webflow Integration (Beta) + path: ./docs/integrations/webflow.mdx - section: Account Management icon: fa-regular fa-users contents: @@ -128,8 +137,6 @@ navigation: contents: - page: Single Sign-On (SSO) Setup path: ./docs/security-and-privacy/setup-sso.md - - page: Compliance and Certifications - path: ./docs/security-and-privacy/compliance.md - page: Data Handling and Classification path: ./docs/security-and-privacy/data-handling.md - page: Network Architecture @@ -159,12 +166,6 @@ navigation: - page: How Vellum Drafts 50%+ of Docs with Promptless path: ./docs/customer-stories/vellum.mdx slug: vellum - - section: Technical - icon: fa-regular fa-code - contents: - - page: "I Have No Mouth, and I Must Scream" - path: ./docs/technical/i-must-scream.mdx - slug: i-must-scream - section: Life at Promptless icon: fa-regular fa-lightbulb contents: @@ -231,8 +232,4 @@ favicon: ./docs/assets/favicon.ico redirects: - source: "/promptless-1-0" - destination: "/docs/getting-started/promptless-1-0" - - source: "/github/adding-repos" - destination: "/docs/integrations/github-integration#adding-more-repos-after-installation" - - source: "/support" - destination: "/docs/getting-started/getting-help" \ No newline at end of file + destination: "/docs/getting-started/promptless-1-0" \ No newline at end of file diff --git a/fern/docs/use-cases/engineering-teams.mdx b/fern/docs/use-cases/engineering-teams.mdx new file mode 100644 index 00000000..990ed2a6 --- /dev/null +++ b/fern/docs/use-cases/engineering-teams.mdx @@ -0,0 +1,50 @@ +--- +title: For Engineering Teams +description: Keep documentation in sync with code changes by automatically generating updates from pull requests +--- + +Promptless monitors your pull requests. When code changes, it generates documentation updates using PR descriptions and context from Linear or Jira. + +## What Promptless Analyzes + +When a PR is opened, Promptless reviews: +- The code diff and changed files +- The PR title and description +- Related issues in Linear or Jira +- Historical patterns in your documentation + +## Publishing Modes + +**Auto-publish mode**: Promptless creates a docs PR linked to your source PR. When your PR merges, the docs PR is ready for review. + +**Draft mode**: Review suggestions in the web interface before any PR is created. + +## Providing Feedback + +Tag @Promptless in GitHub PR comments to request changes. Promptless updates the suggestion accordingly. + +## Typical Workflow + +1. Engineer opens a PR with code changes +2. Promptless analyzes the PR and related context +3. Promptless generates a documentation suggestion +4. Team gets notified in Slack +5. Reviewers provide feedback via PR comments or web interface +6. Documentation publishes when approved + +## Getting Started + + + + [Connect GitHub](/docs/integrations/github-integration) to enable PR monitoring. + + + [Create a project](/docs/getting-started) with GitHub as your trigger. + + + Connect [Linear](/docs/integrations/linear-integration) or [Jira](/docs/integrations/atlassian-integration) for richer context. + + + Set up a Slack channel for notifications. + + diff --git a/fern/docs/use-cases/index.mdx b/fern/docs/use-cases/index.mdx new file mode 100644 index 00000000..2b2ed821 --- /dev/null +++ b/fern/docs/use-cases/index.mdx @@ -0,0 +1,20 @@ +--- +title: Use Cases +description: Common workflows and scenarios where Promptless helps teams automate their documentation +--- + +Promptless adapts to how your team works. + + + + Automatically generate documentation from pull requests. Keep docs in sync with code changes. + + + + Stay on top of product changes. Focus on documentation strategy instead of chasing updates. + + + + Turn resolved support tickets into documentation. Identify gaps based on customer questions. + + diff --git a/fern/docs/use-cases/support-to-docs.mdx b/fern/docs/use-cases/support-to-docs.mdx new file mode 100644 index 00000000..44b9295d --- /dev/null +++ b/fern/docs/use-cases/support-to-docs.mdx @@ -0,0 +1,48 @@ +--- +title: Support Tickets to Docs +description: Automatically identify documentation gaps from support tickets and generate content that helps future customers +--- + +Resolved support tickets contain valuable knowledge—troubleshooting steps, workarounds, and explanations that could help future customers. Promptless analyzes your Zendesk tickets to identify documentation gaps and generate content based on solutions your team already provides. + +## What Promptless Does + +When a ticket is resolved, Promptless: + +- Identifies patterns across similar tickets +- Detects topics missing from your documentation +- Extracts solutions and troubleshooting steps +- Drafts troubleshooting guides, FAQ entries, and feature explanations + +## Publishing Options + +Promptless can publish directly to: + +- Zendesk help centers +- Intercom help content (Beta) +- Any documentation platform connected to your project + +## Typical Workflow + +1. Support team resolves a ticket +2. Promptless analyzes the ticket and related context +3. If documentation should be updated, a suggestion is generated +4. A technical writer or support lead reviews and approves +5. Content publishes to your help center + +## Getting Started + + + + [Set up the Zendesk integration](/docs/integrations/zendesk) to enable ticket analysis. + + + Create a project with Zendesk as your trigger. + + + Connect Zendesk help center or another documentation platform. + + + Configure notifications for your support or documentation team. + + diff --git a/fern/docs/use-cases/technical-writers.mdx b/fern/docs/use-cases/technical-writers.mdx new file mode 100644 index 00000000..30ffd773 --- /dev/null +++ b/fern/docs/use-cases/technical-writers.mdx @@ -0,0 +1,44 @@ +--- +title: For Technical Writers +description: Focus on documentation strategy while Promptless handles routine updates and keeps you informed about product changes +--- + +Promptless handles routine documentation work so you can focus on information architecture and strategy. Instead of attending standups and chasing engineers for context, you get notified when docs need updating—with all the context you need in one place. + +## How Promptless Helps + +Promptless monitors your configured trigger sources and notifies you when documentation updates are needed. You receive notifications in a dedicated Slack channel whenever Promptless detects documentation-worthy changes. + +### Context at a Glance + +When reviewing a suggestion, you see: +- The PR or trigger that initiated the update +- Related Linear or Jira issues +- Relevant Slack conversations +- The proposed documentation changes + +### Provide Feedback + +Use the web interface to: +- Highlight text and add comments +- Request changes that Promptless applies automatically +- Save feedback preferences for future suggestions (e.g., "always include code examples for API endpoints") + +### Audit Trail + +The Triggers page shows all events from the last 30 days. Track what triggered each documentation update and audit your process. + +## Typical Workflow + +1. Promptless monitors PRs, Slack, and other triggers +2. You receive a notification when docs need updating +3. Review the suggestion and related context in the web interface +4. Provide feedback to refine the suggestion +5. Approve and publish when ready + +## Getting Started + +1. Connect your documentation platform via [GitHub](/docs/integrations/github-integration) or another doc collection +2. Create a project with your preferred triggers +3. Set up a dedicated Slack channel for notifications +4. Connect context sources like [Linear](/docs/integrations/linear-integration) or [Jira](/docs/integrations/atlassian-integration) From 46f35c28ba3dff31a77eba1ebc0ecad9c8510e23 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 13 Feb 2026 17:51:12 +0000 Subject: [PATCH 2/5] docs: apply dashboard edit --- fern/docs.yml | 10 ---------- fern/docs/use-cases/index.mdx | 20 -------------------- 2 files changed, 30 deletions(-) delete mode 100644 fern/docs/use-cases/index.mdx diff --git a/fern/docs.yml b/fern/docs.yml index a9dba41f..3f60302d 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -87,16 +87,6 @@ navigation: path: ./docs/features/web-ui-feedback.mdx - page: Providing Feedback path: ./docs/features/providing-feedback.mdx - - section: Use Cases - icon: fa-regular fa-lightbulb - path: ./docs/use-cases/index.mdx - contents: - - page: For Engineering Teams - path: ./docs/use-cases/engineering-teams.mdx - - page: For Technical Writers - path: ./docs/use-cases/technical-writers.mdx - - page: Support Tickets to Docs - path: ./docs/use-cases/support-to-docs.mdx - section: Integrations icon: fa-regular fa-plug path: ./docs/integrations/index.mdx diff --git a/fern/docs/use-cases/index.mdx b/fern/docs/use-cases/index.mdx deleted file mode 100644 index 2b2ed821..00000000 --- a/fern/docs/use-cases/index.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Use Cases -description: Common workflows and scenarios where Promptless helps teams automate their documentation ---- - -Promptless adapts to how your team works. - - - - Automatically generate documentation from pull requests. Keep docs in sync with code changes. - - - - Stay on top of product changes. Focus on documentation strategy instead of chasing updates. - - - - Turn resolved support tickets into documentation. Identify gaps based on customer questions. - - From 47129bee46409f76a05c9017f2fd1fd2e8555d74 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 13 Feb 2026 18:02:19 +0000 Subject: [PATCH 3/5] docs: apply dashboard edit --- fern/docs/use-cases/engineering-teams.mdx | 2 ++ fern/docs/use-cases/technical-writers.mdx | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/fern/docs/use-cases/engineering-teams.mdx b/fern/docs/use-cases/engineering-teams.mdx index 990ed2a6..2b75a947 100644 --- a/fern/docs/use-cases/engineering-teams.mdx +++ b/fern/docs/use-cases/engineering-teams.mdx @@ -7,6 +7,8 @@ Promptless monitors your pull requests. When code changes, it generates document ## What Promptless Analyzes +This is EDIT!!!! + When a PR is opened, Promptless reviews: - The code diff and changed files - The PR title and description diff --git a/fern/docs/use-cases/technical-writers.mdx b/fern/docs/use-cases/technical-writers.mdx index 30ffd773..2446c42e 100644 --- a/fern/docs/use-cases/technical-writers.mdx +++ b/fern/docs/use-cases/technical-writers.mdx @@ -9,7 +9,7 @@ Promptless handles routine documentation work so you can focus on information ar Promptless monitors your configured trigger sources and notifies you when documentation updates are needed. You receive notifications in a dedicated Slack channel whenever Promptless detects documentation-worthy changes. -### Context at a Glance +### Context at a Glance EDITIDNGDNGLGKGKJFLKDGJDJDSLKGJ When reviewing a suggestion, you see: - The PR or trigger that initiated the update From 6df7bcb043b62198ffbe13329dbe0402b6fc023e Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 13 Feb 2026 18:06:52 +0000 Subject: [PATCH 4/5] Sync documentation updates --- fern/docs.yml | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/fern/docs.yml b/fern/docs.yml index 3f60302d..b0150144 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -1,6 +1,8 @@ instances: - url: promptless.docs.buildwithfern.com - custom-domain: docs.gopromptless.ai + custom-domain: + - docs.gopromptless.ai + - docs.promptless.ai title: Promptless | Documentation @@ -34,6 +36,11 @@ navigation: path: ./docs/getting-started.mdx - page: Core Concepts path: ./docs/core-concepts.mdx + - page: Promptless for Open-Source + slug: promptless-oss + path: ./docs/open-source.mdx + - page: Getting Help + path: ./docs/getting-help.mdx - page: Pilot Overview hidden: true path: ./docs/pilot-guide.mdx @@ -67,14 +74,10 @@ navigation: contents: - page: GitHub Repos (Docs as Code) path: ./docs/configuration/doc-collections/github-repos.md - - page: Document360 - path: ./docs/configuration/doc-collections/document360.md - page: Zendesk path: ./docs/configuration/doc-collections/zendesk.md - page: Intercom (Beta) path: ./docs/configuration/doc-collections/intercom.md - - page: Webflow (Beta) - path: ./docs/configuration/doc-collections/webflow.md - section: How to use Promptless icon: fa-regular fa-star path: ./docs/features/index.mdx @@ -87,6 +90,15 @@ navigation: path: ./docs/features/web-ui-feedback.mdx - page: Providing Feedback path: ./docs/features/providing-feedback.mdx + - section: Use Cases + icon: fa-regular fa-lightbulb + contents: + - page: For Engineering Teams + path: ./docs/use-cases/engineering-teams.mdx + - page: For Technical Writers + path: ./docs/use-cases/technical-writers.mdx + - page: Support Tickets to Docs + path: ./docs/use-cases/support-to-docs.mdx - section: Integrations icon: fa-regular fa-plug path: ./docs/integrations/index.mdx @@ -114,8 +126,6 @@ navigation: path: ./docs/integrations/zendesk.mdx - page: Intercom Integration (Beta) path: ./docs/integrations/intercom.md - - page: Webflow Integration (Beta) - path: ./docs/integrations/webflow.mdx - section: Account Management icon: fa-regular fa-users contents: @@ -127,6 +137,8 @@ navigation: contents: - page: Single Sign-On (SSO) Setup path: ./docs/security-and-privacy/setup-sso.md + - page: Compliance and Certifications + path: ./docs/security-and-privacy/compliance.md - page: Data Handling and Classification path: ./docs/security-and-privacy/data-handling.md - page: Network Architecture @@ -156,6 +168,12 @@ navigation: - page: How Vellum Drafts 50%+ of Docs with Promptless path: ./docs/customer-stories/vellum.mdx slug: vellum + - section: Technical + icon: fa-regular fa-code + contents: + - page: "I Have No Mouth, and I Must Scream" + path: ./docs/technical/i-must-scream.mdx + slug: i-must-scream - section: Life at Promptless icon: fa-regular fa-lightbulb contents: @@ -222,4 +240,8 @@ favicon: ./docs/assets/favicon.ico redirects: - source: "/promptless-1-0" - destination: "/docs/getting-started/promptless-1-0" \ No newline at end of file + destination: "/docs/getting-started/promptless-1-0" + - source: "/github/adding-repos" + destination: "/docs/integrations/github-integration#adding-more-repos-after-installation" + - source: "/support" + destination: "/docs/getting-started/getting-help" \ No newline at end of file From 0654e5fc3f602df88d6e8de9c7de7f80b76d160f Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 13 Feb 2026 18:09:12 +0000 Subject: [PATCH 5/5] Sync documentation updates --- fern/docs/use-cases/engineering-teams.mdx | 10 +++++----- fern/docs/use-cases/support-to-docs.mdx | 8 ++++---- fern/docs/use-cases/technical-writers.mdx | 12 ++++++------ 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/fern/docs/use-cases/engineering-teams.mdx b/fern/docs/use-cases/engineering-teams.mdx index 2b75a947..fe196be9 100644 --- a/fern/docs/use-cases/engineering-teams.mdx +++ b/fern/docs/use-cases/engineering-teams.mdx @@ -5,7 +5,7 @@ description: Keep documentation in sync with code changes by automatically gener Promptless monitors your pull requests. When code changes, it generates documentation updates using PR descriptions and context from Linear or Jira. -## What Promptless Analyzes +## WHAT PROMPTLESS ANALYZES This is EDIT!!!! @@ -15,17 +15,17 @@ When a PR is opened, Promptless reviews: - Related issues in Linear or Jira - Historical patterns in your documentation -## Publishing Modes +## PUBLISHING MODES **Auto-publish mode**: Promptless creates a docs PR linked to your source PR. When your PR merges, the docs PR is ready for review. **Draft mode**: Review suggestions in the web interface before any PR is created. -## Providing Feedback +## PROVIDING FEEDBACK Tag @Promptless in GitHub PR comments to request changes. Promptless updates the suggestion accordingly. -## Typical Workflow +## TYPICAL WORKFLOW 1. Engineer opens a PR with code changes 2. Promptless analyzes the PR and related context @@ -34,7 +34,7 @@ Tag @Promptless in GitHub PR comments to request changes. Promptless updates the 5. Reviewers provide feedback via PR comments or web interface 6. Documentation publishes when approved -## Getting Started +## GETTING STARTED diff --git a/fern/docs/use-cases/support-to-docs.mdx b/fern/docs/use-cases/support-to-docs.mdx index 44b9295d..8faefe4e 100644 --- a/fern/docs/use-cases/support-to-docs.mdx +++ b/fern/docs/use-cases/support-to-docs.mdx @@ -5,7 +5,7 @@ description: Automatically identify documentation gaps from support tickets and Resolved support tickets contain valuable knowledge—troubleshooting steps, workarounds, and explanations that could help future customers. Promptless analyzes your Zendesk tickets to identify documentation gaps and generate content based on solutions your team already provides. -## What Promptless Does +## WHAT PROMPTLESS DOES When a ticket is resolved, Promptless: @@ -14,7 +14,7 @@ When a ticket is resolved, Promptless: - Extracts solutions and troubleshooting steps - Drafts troubleshooting guides, FAQ entries, and feature explanations -## Publishing Options +## PUBLISHING OPTIONS Promptless can publish directly to: @@ -22,7 +22,7 @@ Promptless can publish directly to: - Intercom help content (Beta) - Any documentation platform connected to your project -## Typical Workflow +## TYPICAL WORKFLOW 1. Support team resolves a ticket 2. Promptless analyzes the ticket and related context @@ -30,7 +30,7 @@ Promptless can publish directly to: 4. A technical writer or support lead reviews and approves 5. Content publishes to your help center -## Getting Started +## GETTING STARTED diff --git a/fern/docs/use-cases/technical-writers.mdx b/fern/docs/use-cases/technical-writers.mdx index 2446c42e..4a193d3d 100644 --- a/fern/docs/use-cases/technical-writers.mdx +++ b/fern/docs/use-cases/technical-writers.mdx @@ -5,11 +5,11 @@ description: Focus on documentation strategy while Promptless handles routine up Promptless handles routine documentation work so you can focus on information architecture and strategy. Instead of attending standups and chasing engineers for context, you get notified when docs need updating—with all the context you need in one place. -## How Promptless Helps +## HOW PROMPTLESS HELPS Promptless monitors your configured trigger sources and notifies you when documentation updates are needed. You receive notifications in a dedicated Slack channel whenever Promptless detects documentation-worthy changes. -### Context at a Glance EDITIDNGDNGLGKGKJFLKDGJDJDSLKGJ +### CONTEXT AT A GLANCE When reviewing a suggestion, you see: - The PR or trigger that initiated the update @@ -17,18 +17,18 @@ When reviewing a suggestion, you see: - Relevant Slack conversations - The proposed documentation changes -### Provide Feedback +### PROVIDE FEEDBACK Use the web interface to: - Highlight text and add comments - Request changes that Promptless applies automatically - Save feedback preferences for future suggestions (e.g., "always include code examples for API endpoints") -### Audit Trail +### AUDIT TRAIL The Triggers page shows all events from the last 30 days. Track what triggered each documentation update and audit your process. -## Typical Workflow +## TYPICAL WORKFLOW 1. Promptless monitors PRs, Slack, and other triggers 2. You receive a notification when docs need updating @@ -36,7 +36,7 @@ The Triggers page shows all events from the last 30 days. Track what triggered e 4. Provide feedback to refine the suggestion 5. Approve and publish when ready -## Getting Started +## GETTING STARTED 1. Connect your documentation platform via [GitHub](/docs/integrations/github-integration) or another doc collection 2. Create a project with your preferred triggers