diff --git a/fern/docs.yml b/fern/docs.yml index 8a5f917..04dfa2a 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -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 diff --git a/fern/docs/changelogs/2026-01.md b/fern/docs/changelogs/2026-01.md index bb0b8ea..2d97142 100644 --- a/fern/docs/changelogs/2026-01.md +++ b/fern/docs/changelogs/2026-01.md @@ -4,12 +4,22 @@ 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. + * **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. Atlassian integration showing both Jira projects and Confluence spaces in a unified interface +* **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. + +* **Automatic Support Channel:** Installing the Promptless Slack app automatically creates a shared Slack Connect channel and sends you an invitation. Accept to get a direct line to the Promptless team for questions and support—no setup required. + +* **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. + **Improvements:** * **Upgraded to Claude Opus 4.5:** Documentation suggestions now use Claude Opus 4.5 for improved reasoning, analysis, and documentation context understanding. @@ -24,12 +34,13 @@ title: January 2026 * **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—since Promptless now archives diffs before cleanup. +* **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. -* **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. +* **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. **Bug Fixes:** @@ -41,6 +52,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. @@ -54,3 +66,9 @@ 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. * **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. * **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. +* **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. +* **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. +* **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, and various visual glitches during page transitions. +* **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. diff --git a/fern/docs/features/deep-analysis.mdx b/fern/docs/features/deep-analysis.mdx new file mode 100644 index 0000000..7ece3d9 --- /dev/null +++ b/fern/docs/features/deep-analysis.mdx @@ -0,0 +1,62 @@ +--- +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 + + + + Click **Deep Analysis** in the sidebar. + + + + Choose the doc collection you want to update. + + + + Add a descriptive title for 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. + + + + Upload supporting files if needed (up to 5 files, 10MB each). + + + + Click **Submit Request**. + + + + +Deep Analysis requests may take several hours to complete and can create multiple suggestions across your documentation. + + +## 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). diff --git a/fern/docs/features/index.mdx b/fern/docs/features/index.mdx index cadc531..5ca0765 100644 --- a/fern/docs/features/index.mdx +++ b/fern/docs/features/index.mdx @@ -19,4 +19,8 @@ Promptless offers multiple ways to interact with the platform and generate docum Highlight text, add comments, and provide feedback directly in Promptless's web interface. + + + Submit large, complex documentation requests like refactoring sections, auditing for consistency, or writing docs from scratch. +