Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
290d339
Add Guided Onboarding Wizard to January 2026 changelog
promptless[bot] Jan 14, 2026
2a4c236
Sync documentation updates
promptless[bot] Jan 14, 2026
91e8430
Sync documentation updates
promptless[bot] Jan 14, 2026
bcb0224
Sync documentation updates
promptless[bot] Jan 15, 2026
ffcf56d
Sync documentation updates
promptless[bot] Jan 15, 2026
d7c2e11
Sync documentation updates
promptless[bot] Jan 15, 2026
5a510b7
Sync documentation updates
promptless[bot] Jan 15, 2026
09edda5
Sync documentation updates
promptless[bot] Jan 15, 2026
bbb1c81
Sync documentation updates
promptless[bot] Jan 15, 2026
1ac673c
Sync documentation updates
promptless[bot] Jan 15, 2026
01a0131
Sync documentation updates
promptless[bot] Jan 15, 2026
633b47d
Sync documentation updates
promptless[bot] Jan 15, 2026
c0bfb96
Sync documentation updates
promptless[bot] Jan 15, 2026
3dd6589
Sync documentation updates
promptless[bot] Jan 15, 2026
d345a12
Sync documentation updates
promptless[bot] Jan 15, 2026
32c867e
Sync documentation updates
promptless[bot] Jan 15, 2026
7807693
Sync documentation updates
promptless[bot] Jan 15, 2026
1f22109
Sync documentation updates
promptless[bot] Jan 15, 2026
e414aea
Sync documentation updates
promptless[bot] Jan 15, 2026
6459ba0
Sync documentation updates
promptless[bot] Jan 15, 2026
571175b
Sync documentation updates
promptless[bot] Jan 15, 2026
d32bbec
Sync documentation updates
promptless[bot] Jan 15, 2026
425c944
Sync documentation updates
promptless[bot] Jan 16, 2026
c4fae89
Sync documentation updates
promptless[bot] Jan 16, 2026
a6a33a4
Sync documentation updates
promptless[bot] Jan 17, 2026
e086af5
Sync documentation updates
promptless[bot] Jan 17, 2026
45f1454
Sync documentation updates
promptless[bot] Jan 17, 2026
beb23fa
Sync documentation updates
promptless[bot] Jan 18, 2026
149c184
Sync documentation updates
promptless[bot] Jan 18, 2026
5c3f3ad
Sync documentation updates
promptless[bot] Jan 20, 2026
dde40d5
Sync documentation updates
promptless[bot] Jan 21, 2026
b7e48a6
Sync documentation updates
promptless[bot] Jan 21, 2026
bd68a18
Sync documentation updates
promptless[bot] Jan 22, 2026
282bcc3
Sync documentation updates
promptless[bot] Jan 22, 2026
b92a1a7
Sync documentation updates
promptless[bot] Jan 22, 2026
719fd36
Sync documentation updates
promptless[bot] Jan 22, 2026
34b52e3
Sync documentation updates
promptless[bot] Jan 22, 2026
3a2a8ac
Sync documentation updates
promptless[bot] Jan 23, 2026
6438de0
Sync documentation updates
promptless[bot] Jan 23, 2026
bc3e45a
Sync documentation updates
promptless[bot] Jan 24, 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
4 changes: 4 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ navigation:
path: ./docs/features/github-pr-comments.mdx
- page: Using the Web Interface
path: ./docs/features/web-ui-feedback.mdx
- page: Providing Feedback
path: ./docs/features/providing-feedback.mdx
- page: Deep Analysis
path: ./docs/features/deep-analysis.mdx
- section: Integrations
icon: fa-regular fa-plug
path: ./docs/integrations/index.mdx
Expand Down
38 changes: 33 additions & 5 deletions fern/docs/changelogs/2026-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,26 @@ title: January 2026

**New Features:**

* **Agent Knowledge Base:** View and edit the files that inform how Promptless writes documentation—your style guide, product overview, and documentation guidelines. Find them in Settings under the Agent Knowledge Base tab. Promptless updates these files automatically as it learns from your feedback, but you can also edit them directly.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1826 which adds AgentKnowledgeTab.tsx - a new tab in Settings allowing users to view and edit .long_term_context/ files.
View source


* **Atlassian Integration (Jira + Confluence):** Connect both Jira and Confluence through a single unified Atlassian integration. Promptless now searches your Confluence spaces alongside Jira tickets—pulling documentation patterns, terminology, and architectural decisions when creating suggestions. This replaces the previous Jira-only integration—if you previously connected Jira, reconnect to access Confluence while preserving your Jira project configuration.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/atlassian-integration-confluence-jira-unified-517b0f75.png" alt="Atlassian integration showing both Jira projects and Confluence spaces in a unified interface" />
</Frame>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1741 which implements the 6-step onboarding wizard. Key implementation details from the PR description: wizard state persisted by org_id (not user), enabling team member handoff, and progress hydration via React state hooks.
View source


* **Guided Onboarding Wizard:** A 6-step wizard walks new users through Promptless setup: connecting Slack, connecting your documentation platform, configuring triggers, adding context sources, setting agent preferences, and starting your trial. Progress saves automatically—leave and return to pick up where you left off. Team members from the same organization can continue setup without losing previous progress.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1799 which adds server/slack/onboarding.py - a new module that automatically creates Slack Connect support channels when customers install the Promptless Slack app. The workflow creates a channel in the Promptless workspace and sends an invitation to the installer.
View source

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Removed the "Automatic Support Channel" changelog entry because PR #1851 disabled this feature due to a bug. The feature was commented out (not deleted) in server/slack/routes.py, indicating this is a temporary disable that may be re-enabled later.
View source


* **Automatic Support Channel:** When you connect Slack during onboarding, Promptless creates a shared Slack Connect channel between your team and ours. Use it to ask questions, share feedback, and get support.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Prithvi confirmed users can now self-signup at accounts.gopromptless.ai. Added to changelog as a new feature.
View source

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #1852 re-enables Slack Connect support channel creation during onboarding only (when onboarding_completed is false). This feature was previously disabled in PR #1851. See changes in slack/routes.py.
View source


* **Self-Service Signup:** Sign up for Promptless at [accounts.gopromptless.ai](https://accounts.gopromptless.ai)—no sales call required.

* **Deep Analysis:** Submit large documentation requests—like refactoring entire sections, auditing for consistency, or writing comprehensive docs from scratch. Access Deep Analysis from the sidebar, select your doc collection, describe what you need, and optionally attach supporting files. The Promptless team reviews your request and begins processing, which may create multiple suggestions across your documentation.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1838 which adds the Deep Analysis page. Feature details from promptless-dashboard/src/app/deep-analysis/page.tsx including templates (refactor docs, add error codes, write from scratch, audit for consistency), file attachment limits (5 files, 10MB each), and the manual review workflow.
View source


* **Triggers Page Search:** Search for triggers by PR info, Slack thread topic, task name, or summary text. The default view shows the last 30 days, but search retrieves matching triggers from your full history.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Changelog entry for Triggers Page Search based on PR #1869. The PR adds a search box to the Triggers page with debounced search and removes the 30-day limit when searching, allowing users to find older events.
View source


* **Read-Only GitHub App for Open Source Repos:** Connect Promptless to open source repositories where you can't install GitHub apps. The read-only app only requests read permissions—documentation PRs are created from a fork using a Promptless service account. Select "Use read-only app (for open source repos)" when connecting GitHub.

**Improvements:**
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1882 which introduces the github_oss integration type with a read-only GitHub app and fork-based PR workflow for open source repositories.
View source


* **Upgraded to Claude Opus 4.5:** Documentation suggestions now use Claude Opus 4.5 for improved reasoning, analysis, and documentation context understanding.
Expand All @@ -24,12 +38,14 @@ title: January 2026
</Frame>

* **Ready Count Includes Open PRs:** The Ready count on the Change History page now includes suggestions with open documentation PRs—not just unpublished suggestions. Previously, only suggestions without PRs were counted as ready, so you can now see everything that needs your review in one place.
* **Suggestions Stay Active When Being Reviewed:** Viewing a suggestion now counts as activity—so suggestions you're actively reviewing stay active even if no edits are made for over 30 days. Previously, suggestions would be automatically pruned after 30 days of inactivity. This works alongside the "Viewed" file checkbox added in December for tracking review progress.
* **Faster Suggestion Page Loading:** The Change History page now loads faster. Suggestion metadata—titles, descriptions, and trigger details—appears immediately while the diff loads in parallel.
* **Smarter Screenshot Capture:** Promptless now makes better decisions about when to capture fresh screenshots for documentation. When processing UI changes, Promptless proactively identifies which screenshots need updating and captures fresh, high-quality images from your live product.
* **Screenshot Cropping:** Promptless can now crop screenshots to focus on specific UI elements—highlighting exactly what users need to see without extra clutter.
* **Suggestion Lifecycle Improvements:** Viewing a suggestion now counts as activity—so suggestions you're actively reviewing stay active even if no edits are made for over 30 days. You can also view the full diff of any suggestion—even after it's been closed or merged.
* **Change History Page Enhancements:** The page now loads faster with suggestion metadata appearing immediately while diffs load in parallel. New filtering by trigger source (Slack, Web UI, GitHub) and estimated review times help prioritize your review queue—sort by "Shortest review" to clear small updates first.
* **Screenshot Improvements:** Promptless now makes better decisions about when to capture fresh screenshots and can crop them to focus on specific UI elements—highlighting exactly what users need to see without extra clutter.
* **Automatic Suggestion Updates from Main:** When changes are pushed to your documentation's main branch, Promptless merges those updates into all open suggestion branches and automatically resolves any conflicts.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on help link added in promptless-dashboard/src/app/onboarding/triggers/page.tsx that appears when users uncheck "Trigger on all repos".
View source

* **Trigger Source Filter:** Filter suggestions on the Change History page by how they were triggered—Slack messages, Web UI requests, or GitHub PRs. For GitHub, expand the dropdown to filter by specific repositories.
* **Rich PR Descriptions:** Documentation PRs now include a "Promptless Research" section with clickable links to every source reviewed—files, GitHub PRs, Slack conversations, and more—plus an explanation of the changes. For suggestions with multiple triggers, each trigger's context appears in collapsible sections.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on "Installation Pending" UI flow added in promptless-dashboard/src/app/onboarding/slack/page.tsx for handling Slack OAuth access_denied errors.
View source

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Added Rich PR Descriptions and Inline PR Citations based on PR #1804 which adds pr_helpers.py for formatting research summaries and sync_pr_with_suggestion_metadata() and add_citation_comments_to_pr() functions in github.py.
View source

* **Inline PR Citations:** Citations now appear as review comments on specific lines in your documentation PRs. See the exact source—GitHub PR, Slack message, or Jira ticket—that informed each change directly in the diff view.
* **Onboarding Wizard Enhancements:** Several improvements throughout the wizard—your docs repository is now automatically excluded when triggering on all repos, monorepo setups prompt you to select specific repositories, help links guide you to documentation when needed, and the calibration card now shows that you'll receive a Slack notification when PR replays complete. If your Slack connection doesn't complete, a recovery flow shows options to try again, continue without Slack, or contact your admin.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Updated entry wording based on merged implementation in promptless-dashboard/src/app/onboarding/slack/page.tsx. The UI shows "Installation Not Completed" (not "Installation Pending") and handles both cancellation and admin approval cases.
View source

* **Simplified Intercom Connection:** Connecting Intercom is now a one-click OAuth flow for all users. Previously, some organizations had to manually create an app in the Intercom Developer Hub and enter an access token—now everyone connects through standard OAuth authorization.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1823 which adds suggestion_diff_archive table and archive_and_prune_branch helper to preserve diffs before branch pruning. Key files: publishing/diff_archive.py, publishing/branch_pruning.py, and updates to suggestions/modules/lifecycle.py for get_archived_diff() function.
View source

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1861 which removes the IntercomModal component and INTERCOM_DIRECT_AUTH_ORGS list in IntegrationsList.tsx, switching all Intercom connections to use OAuth instead of manual access token entry.
View source


Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1815 which adds a notification message to the calibration card: "Promptless will notify you in Slack when replays are complete". See changes in promptless-dashboard/src/app/onboarding/trial/page.tsx lines 253-259 adding the willNotify property and notice display.
View source

**Bug Fixes:**
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Added improvement entry for removing "Connected" badges from trigger options. Based on changes in promptless-dashboard/src/app/onboarding/triggers/page.tsx which removed the connectedBadge and connectedIcon elements. PR description explains badges were "misleading and noisy, giving the impression no further work is needed."
View source


Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #1812 adds monorepo handling in the onboarding wizard's triggers step (src/app/onboarding/triggers/page.tsx) - hides "Trigger on all accessible repos" when isMonorepo is true, and implements excluded_repos check in GitHub/Bitbucket/GitLab trigger routes to auto-exclude docs repo.
View source

Expand All @@ -41,6 +57,7 @@ title: January 2026
* **Comment Bubble Overflow:** Fixed comment bubbles extending beyond the editor viewport, keeping all interface elements properly contained within the editing area.
* **Cleaner Suggestion Diffs:** Fixed suggestion diffs to exclude internal system files—diffs now show only your documentation changes, making them easier to review.
* **Slack Notification Diff Files:** Fixed diff file attachments in Slack notifications—teams can now see the full diff of documentation changes directly from Slack without needing to open the PR or web interface.
* **Slack Notification Delivery:** Improved reliability of Slack notifications by automatically retrying on transient errors. Notifications that previously failed due to temporary Slack service issues (5xx errors, connection problems, rate limits) are now retried automatically.
* **Git Sync Reliability:** Improved reliability of git sync operations when Promptless pushes documentation changes—sync operations now properly wait for concurrent git processes to complete, preventing intermittent failures.
* **Git Repository Access Reliability:** Fixed intermittent failures from git configuration lock contention when processing multiple documentation updates simultaneously.
* **GitHub PR Processing:** Improved reliability when processing GitHub PRs with many file changes—Promptless now handles large PRs with multiple files more consistently, preventing intermittent errors during analysis.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Bug fix restores accidentally removed skip logic in routes.py that caused Promptless to process ALL pull_request webhook events instead of only opened, ready_for_review, and reopened events.
View source

Expand All @@ -54,3 +71,14 @@ title: January 2026
* **Suggestion Stability for Revert PRs:** Fixed an issue where suggestions could be incorrectly deleted when processing PRs that revert previously documented changes—suggestions now remain active and continue receiving updates correctly.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #1809 removes DUMMY_REPOS and DUMMY_SLACK_CHANNELS constants from page.tsx and replaces them with real data fetched from orgConfig for GitHub/GitLab/Bitbucket repos and Slack channels.
View source

* **PR Replay Status Accuracy:** Fixed PR replays to show the correct PR status on the Triggers page. Previously, replayed PRs always showed "open" status regardless of whether the PR was actually merged, closed, or in draft state.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1810 which fixes the persistence of agentBehaviors and selectedBetaFeatures in OnboardingContext.tsx and routes.py. The bug was that agent preferences configured during onboarding were never being saved—_persist_agent_behaviors() was added to actually persist selections when the preferences step completes.
View source

* **GitHub Trigger Icons:** Fixed the Change History page to show the GitHub icon for all GitHub-based triggers—including GitHub Enterprise PRs, merged PRs, and GitHub Issues. Previously, the icon only appeared for regular open PRs.
* **GitHub PR Event Filtering:** Fixed an issue where Promptless could trigger on PR events like `edited` or `synchronize` instead of only triggering when PRs are opened, marked ready for review, or reopened.
* **GitHub Integration Reliability:** Promptless now handles server clock drift that could cause intermittent authentication errors and automatically retries operations when GitHub's API returns transient server errors.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Added bug fix entry based on PR #1863. Key changes: generate_github_jwt() in server/utils/sources/github.py now backdates JWT iat claim by 60 seconds to handle clock drift, and get_installation_access_token() has retry with exponential backoff for 5xx errors plus better error handling.
View source

* **Duplicate Trigger Context in PRs:** Fixed trigger context appearing twice in documentation PRs—once in the PR description and again as separate comments. Trigger context now appears only in the PR description.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #1877 which adds mark_pr_description_trigger_events_as_posted() function in server/utils/sources/github.py to mark trigger events included in PR descriptions as posted, preventing them from being re-posted as comments.
View source

* **Large Image Processing:** Fixed failures when processing triggers with large images. Promptless now automatically compresses images that exceed size limits, so you can include high-resolution screenshots and images in Slack messages, GitHub issues, or other triggers without issues.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: PR #1811 fixes 500 errors during pipeline autocreation by removing deleted docs_platform and docs_repo columns from the doc_pipeline upsert method in server/utils/config.py. The PR also moves pipeline creation from step 5 (preferences) to step 4 (context sources).
View source

* **Documentation PR Update Reliability:** Fixed intermittent failures when updating documentation PRs with new changes. Promptless now handles transient GitHub API timing issues more gracefully, ensuring suggestions are consistently applied to your docs PRs.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Bug fix entry based on PR #1813 which adds external_limited=False to conversations.inviteShared API call in server/slack/onboarding.py, making Slack Connect support channels public instead of private in the customer's workspace.
View source

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Bug fix for OAuth redirect visual flickering, based on changes in promptless-dashboard/src/app/integrations/[[...slug]]/page.tsx (OAuth callback loading spinner), promptless-dashboard/src/app/onboarding/context/OnboardingContext.tsx (exposing hydrated state), and promptless-dashboard/src/app/onboarding/components/StepContainer.tsx (showing spinner until hydration completes).
View source

* **Onboarding Wizard Stability:** Fixed multiple issues in the onboarding wizard—including OAuth integration setup, progress saving after connecting Slack, trigger dropdowns showing placeholder data, agent preferences not persisting, PR replays not starting for GitHub triggers, Slack notification channel settings being lost when resuming onboarding, and various visual glitches during page transitions.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Bug fix for Slack notification channel not persisting during resumed onboarding. The wizard now refreshes state from org config on resumed onboarding, ensuring slack.notificationChannel is preserved. Changes in promptless-dashboard/src/app/onboarding/slack/page.tsx.
View source

* **Slack Connect Channel Visibility:** Fixed an issue where Slack Connect support channels were created as private in your workspace—support channels now appear as public, so you can invite other team members from your organization.
* **High-Volume Trigger Processing:** Fixed intermittent errors when processing triggers for organizations with many concurrent documentation tasks.
* **Review Time Estimate Accuracy:** Fixed review time estimates being inflated for repositories with mixed line endings (CRLF and LF). Estimates now accurately reflect the actual scope of documentation changes.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Bug fix from PR #1867 that normalizes line endings (CRLF → LF) in server/utils/diff_utils.py before computing diff stats, preventing mixed line endings in customer repos from inflating estimated review times.
View source

* **Suggestion Timestamp Display:** Fixed suggestion timestamps showing incorrect times—such as appearing hours in the future—when viewing the Change History page.
* **Agent Knowledge Base Persistence:** Fixed an issue where edits to Agent Knowledge Base files could be lost between documentation processing runs—your customizations now persist properly.
62 changes: 62 additions & 0 deletions fern/docs/features/deep-analysis.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: New documentation page based on PR #1838. Feature implementation details from promptless-dashboard/src/app/deep-analysis/page.tsx including the TEMPLATES array defining the four templates, MAX_ATTACHMENT_COUNT (5), MAX_ATTACHMENT_SIZE_BYTES (10MB), and the form fields (doc collection, title, description, attachments).
View source

title: Deep Analysis
description: Submit large, complex documentation requests that may take extended processing time and create multiple suggestions
---

Deep Analysis handles large, complex documentation requests that require extended processing time and may create multiple suggestions across your docs.

## When to use Deep Analysis

Use Deep Analysis for requests that go beyond individual page updates:

- **Refactoring documentation sections** - Restructure or rewrite entire sections to match a new pattern or better examples
- **Documentation audits** - Review all documentation for consistency, accuracy, or style compliance
- **Writing docs from scratch** - Create comprehensive documentation for new features or products
- **Adding to OpenAPI specs** - Add error codes, examples, or other structured data across your API documentation

For routine updates, use Slack, GitHub PR triggers, or the New Task feature instead.

## Submitting a request

<Steps>
<Step title="Open Deep Analysis">
Click **Deep Analysis** in the sidebar.
</Step>

<Step title="Select a doc collection">
Choose the doc collection you want to update.
</Step>

<Step title="Enter a title">
Add a descriptive title for your request.
</Step>

<Step title="Describe your request">
Provide details about what you need—include context about your goals, examples of good documentation to model, and specific areas to focus on.
</Step>

<Step title="Attach files (optional)">
Upload supporting files if needed (up to 5 files, 10MB each).
</Step>

<Step title="Submit">
Click **Submit Request**.
</Step>
</Steps>

<Note>
Deep Analysis requests may take several hours to complete and can create multiple suggestions across your documentation.
</Note>

## Templates

Deep Analysis includes templates for common request types:

- **Refactor a bad section of docs** - Improve an existing section using another set of docs as a model
- **Add error codes to OpenAPI spec** - Add comprehensive error codes and examples to your API specification
- **Write docs from scratch** - Create new documentation with guidance on outline, audience, and style
- **Audit for consistency** - Review all documentation for consistent terminology, formatting, and structure

Select a template to pre-fill the title and description with prompts that help you provide the right context.

Need help with Deep Analysis? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai).
4 changes: 4 additions & 0 deletions fern/docs/features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,8 @@ Promptless offers multiple ways to interact with the platform and generate docum
<Card title="Using the Web Interface" icon="regular browser" href="/how-to-use-promptless/using-the-web-interface">
Highlight text, add comments, and provide feedback directly in Promptless's web interface.
</Card>

<Card title="Deep Analysis" icon="regular magnifying-glass-chart" href="/how-to-use-promptless/deep-analysis">
Submit large, complex documentation requests like refactoring sections, auditing for consistency, or writing docs from scratch.
</Card>
</CardGroup>