From a3f0e03db562e28207afb67a85060e8c4228db3a Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Tue, 20 May 2025 19:01:21 +0000 Subject: [PATCH] Documentation updates from Promptless --- docs/changelogs/2025-05.md | 22 +++++++ docs/using-promptless/suggestions.md | 93 ++++++++++++++++++++++++++++ 2 files changed, 115 insertions(+) create mode 100644 docs/changelogs/2025-05.md create mode 100644 docs/using-promptless/suggestions.md diff --git a/docs/changelogs/2025-05.md b/docs/changelogs/2025-05.md new file mode 100644 index 0000000..991a190 --- /dev/null +++ b/docs/changelogs/2025-05.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 0 +title: May 2025 +--- + +### May 20, 2025 + +**What's New:** + +* **Improved Suggestions UI:** We've redesigned the suggestions table in the Change History page to provide a clearer view of your documentation updates. The new UI shows each suggestion with its title, description, affected files, and associated trigger events, making it easier to track how documentation changes are connected to specific events in your development workflow. + +* **Multiple Trigger Events Support:** Suggestions can now be associated with multiple trigger events. For example, a single documentation update might be triggered by both a GitHub pull request and a follow-up Slack conversation, giving you better context for each documentation change. + +* **Clickable Trigger Events:** Trigger events in the Change History page now include direct links to their original sources. You can click on a trigger event to navigate directly to the GitHub pull request, Slack message, Zendesk ticket, or other source that initiated the documentation update. + +**Bug Fixes:** + +* **PR Comments:** Fixed an issue where "no suggestions" comments weren't consistently shown on GitHub and Bitbucket pull requests when no documentation updates were needed. Now, users will always receive feedback on their pull requests, whether or not documentation changes are required. + +**Documentation Updates:** + +* Added a new guide on [Managing Documentation Suggestions](/using-promptless/suggestions) that explains how to review, edit, and publish documentation suggestions in the Promptless dashboard. \ No newline at end of file diff --git a/docs/using-promptless/suggestions.md b/docs/using-promptless/suggestions.md new file mode 100644 index 0000000..d1c27b6 --- /dev/null +++ b/docs/using-promptless/suggestions.md @@ -0,0 +1,93 @@ +--- +sidebar_position: 1 +--- + +# Managing Documentation Suggestions + +When Promptless is triggered by events like GitHub pull requests or Slack messages, it generates documentation suggestions that you can review, edit, and publish. This page explains how to work with these suggestions in the Promptless dashboard. + +## Viewing Suggestions + +All documentation suggestions are available in the [Change History](https://app.gopromptless.ai/change-history) section of the Promptless dashboard. This page displays a table of all suggestions, including: + +- **Suggestion**: The title and description of the suggested documentation change +- **Files Changed**: A list of files that have been modified, added, or deleted as part of the suggestion +- **Trigger Events**: The events that triggered this suggestion, such as GitHub pull requests or Slack messages +- **Status**: The current status of the suggestion (pending, published, etc.) + +![Suggestions Table](https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/suggestions-table-example.png) + +Each suggestion may be associated with multiple trigger events. For example, a single documentation update might be triggered by both a GitHub pull request and a follow-up Slack conversation. + +### Clickable Trigger Events + +Trigger events in the Change History page are clickable links that take you directly to the original source: + +- GitHub or Bitbucket pull requests open in a new tab to the PR that triggered the suggestion +- Slack messages open to the specific thread where the suggestion was requested +- Zendesk tickets link directly to the support conversation + +This feature helps you quickly access the context that led to a documentation suggestion, making it easier to understand why certain changes were recommended. + +## Reviewing Suggestion Details + +Click on any suggestion in the table to view its details. The suggestion detail page shows: + +1. The complete suggestion information, including title and description +2. All files that have been modified, with a diff view showing the changes +3. The trigger events that led to this suggestion +4. Options to publish, edit, or reject the suggestion + +## Publishing Suggestions + +When you're satisfied with a suggestion, you can publish it directly from the suggestion detail page. Depending on your project configuration, publishing will either: + +- Create a pull request in your documentation repository with the suggested changes +- Directly commit the changes to your documentation repository +- Publish the changes to your documentation platform (for integrations like Zendesk or Intercom) + +## Editing Suggestions + +If a suggestion needs modifications before publishing, you can edit it directly in the Promptless dashboard: + +1. Navigate to the suggestion detail page +2. Click the "Edit" button next to any file +3. Make your changes in the editor +4. Save your changes + +You can also request additional changes from Promptless using the follow-on request feature, which allows you to provide specific instructions for how the suggestion should be modified. + +## Rejecting Suggestions + +If a suggestion is not needed, you can reject it: + +1. Navigate to the suggestion detail page +2. Click the "Reject" button +3. Optionally, provide a reason for the rejection + +Rejected suggestions are removed from your active suggestions list but remain in the system for reference. + +## Filtering and Searching Suggestions + +The Change History page provides options to filter and search suggestions: + +- Filter by status (pending, published, rejected) +- Filter by trigger type (GitHub, Slack, etc.) +- Search by suggestion title or description +- Filter by date range + +These filtering options help you manage large numbers of suggestions and find specific items quickly. + +## Understanding Suggestion Status + +Suggestions can have the following statuses: + +- **Pending**: The suggestion has been created but not yet published or rejected +- **Published**: The suggestion has been published to your documentation +- **Rejected**: The suggestion has been reviewed and rejected + +## Related Features + +- **Auto-publish**: When enabled in your project settings, suggestions will be automatically published without manual review +- **Follow-on Requests**: Request additional changes or refinements to a suggestion +- **Notification Settings**: Configure how you want to be notified about new suggestions \ No newline at end of file