From b262b02ec61c20bac850722ecbb36521748afe78 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 9 Jan 2026 04:34:58 +0000 Subject: [PATCH 1/2] Add comprehensive feedback documentation to web interface guide --- fern/docs/features/web-ui-feedback.mdx | 61 ++++++++++++++++++++++---- 1 file changed, 52 insertions(+), 9 deletions(-) diff --git a/fern/docs/features/web-ui-feedback.mdx b/fern/docs/features/web-ui-feedback.mdx index f9109bb..798f2a5 100644 --- a/fern/docs/features/web-ui-feedback.mdx +++ b/fern/docs/features/web-ui-feedback.mdx @@ -11,33 +11,76 @@ Each suggestion includes a title and description that explains what changes are Suggestion description with markdown formatting showing bold headers and bullet lists -### Comment and feedback +### Ways to provide feedback -Select to highlight specific portions of documentation to provide targeted comment or feedback. +Provide feedback on suggestions through request changes, inline comments, overall comments, or close feedback. Each method lets you request immediate changes or save preferences for future suggestions. + +### 1. Request Changes + +Use the **Request Changes** button at the top of any suggestion to request updates. Provide multiple pieces of feedback at once, and Promptless will address them all together. - Add Comment button in web interface + Request Changes button with text field and example suggestions -When providing feedback through the web interface, you'll see two checkbox options that control how your feedback is processed: +The interface includes common examples to get you started: +- "Put X file's content as a section in Y file instead of making it its own file" +- "Make the tone more conversational, and do that for all future suggestions too" +- "I always want changelog entries in their own suggestion—please move" + +Click **Submit Request** to process all your feedback. + +### 2. Inline Comments + +Add comments to specific files or sections within a suggestion for targeted feedback. Click **Edit** or **Add Comment** on any file to provide context-specific input. - Feedback panel showing two checkbox options + Inline comment buttons showing Edit and Add Comment options -**1. Request changes on this suggestion** +When you add an inline comment, you'll see a feedback panel with two options: - When checked, this option tells Promptless to apply your feedback and make changes to the current documentation suggestion. You'll be able to add more comments and submit them for implementaion all in one go. + + Feedback panel with checkboxes for immediate changes and future learning + -**2. Remember feedback for future suggestions** +**Request changes on this suggestion**: Promptless will apply your feedback to the current suggestion. You can add multiple comments and submit them all at once. - When checked, this option saves your feedback preferences and applies them to future documentation suggestions. This helps Promptless learn your style preferences and documentation standards over time. +**Remember feedback for future suggestions**: Promptless saves your preferences and applies them to future documentation. This helps it learn your style and standards over time. **Examples of feedback to remember:** - "Always include code examples for API endpoints" - "Use active voice instead of passive voice" - "Include troubleshooting sections for configuration guides" +### 3. Overall Comments + +Leave general feedback about a suggestion without targeting a specific file. This is useful for high-level guidance or when your feedback applies to the entire suggestion. + + + Overall comments section with text field and feedback options + + +Like inline comments, you can choose whether to request immediate changes or remember the feedback for future suggestions. + +### 4. Close Suggestion Feedback + +When closing a suggestion, provide feedback about why you're rejecting it. This helps Promptless improve future suggestions. + + + Close suggestion dialog with reason checkboxes and optional feedback field + + +Select one or more reasons: +- "I copied this change into my docs editor" +- "This change is incorrect" +- "This change is too insignificant" +- "This change was covered in another Promptless suggestion" +- "This is already in my docs" +- "This change is self-explanatory and doesn't need docs" + +You can also provide additional context in the feedback field. Check "Remember this feedback for future suggestions" to save your preferences. + ### Triggers page The Triggers page shows all events that triggered Promptless to review your documentation over the last 30 days. Each entry displays: From 5414b22390432732c8a8c306ec86418330954e86 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 9 Jan 2026 05:02:24 +0000 Subject: [PATCH 2/2] Sync documentation updates --- fern/docs.yml | 2 + fern/docs/features/providing-feedback.mdx | 74 +++++++++++++++++++++++ fern/docs/features/web-ui-feedback.mdx | 70 +-------------------- 3 files changed, 78 insertions(+), 68 deletions(-) create mode 100644 fern/docs/features/providing-feedback.mdx diff --git a/fern/docs.yml b/fern/docs.yml index 4b8d06a..cdf691e 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -80,6 +80,8 @@ 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 - section: Integrations icon: fa-regular fa-plug path: ./docs/integrations/index.mdx diff --git a/fern/docs/features/providing-feedback.mdx b/fern/docs/features/providing-feedback.mdx new file mode 100644 index 0000000..cf358d9 --- /dev/null +++ b/fern/docs/features/providing-feedback.mdx @@ -0,0 +1,74 @@ +--- +title: Providing Feedback +description: Learn all the ways to provide feedback on Promptless documentation suggestions +--- + +Provide feedback on suggestions through request changes, inline comments, overall comments, or close feedback. Each method lets you request immediate changes or save preferences for future suggestions. + +## 1. Request Changes + +Use the **Request Changes** button at the top of any suggestion to request updates. Provide multiple pieces of feedback at once, and Promptless will address them all together. + + + Request Changes button with text field and example suggestions + + +The interface includes common examples to get you started: +- "Put X file's content as a section in Y file instead of making it its own file" +- "Make the tone more conversational, and do that for all future suggestions too" +- "I always want changelog entries in their own suggestion—please move" + +Click **Submit Request** to process all your feedback. + +## 2. Inline Comments + +Add comments to specific files or sections within a suggestion for targeted feedback. Click **Edit** or **Add Comment** on any file to provide context-specific input. + + + Inline comment buttons showing Edit and Add Comment options + + +When you add an inline comment, you'll see a feedback panel with two options: + + + Feedback panel with checkboxes for immediate changes and future learning + + +**Request changes on this suggestion**: Promptless will apply your feedback to the current suggestion. You can add multiple comments and submit them all at once. + +**Remember feedback for future suggestions**: Promptless saves your preferences and applies them to future documentation. This helps it learn your style and standards over time. + + **Examples of feedback to remember:** + - "Always include code examples for API endpoints" + - "Use active voice instead of passive voice" + - "Include troubleshooting sections for configuration guides" + +## 3. Overall Comments + +Leave general feedback about a suggestion without targeting a specific file. This is useful for high-level guidance or when your feedback applies to the entire suggestion. + + + Overall comments section with text field and feedback options + + +Like inline comments, you can choose whether to request immediate changes or remember the feedback for future suggestions. + +## 4. Close Suggestion Feedback + +When closing a suggestion, provide feedback about why you're rejecting it. This helps Promptless improve future suggestions. + + + Close suggestion dialog with reason checkboxes and optional feedback field + + +Select one or more reasons: +- "I copied this change into my docs editor" +- "This change is incorrect" +- "This change is too insignificant" +- "This change was covered in another Promptless suggestion" +- "This is already in my docs" +- "This change is self-explanatory and doesn't need docs" + +You can also provide additional context in the feedback field. Check "Remember this feedback for future suggestions" to save your preferences. + +Need help? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai). diff --git a/fern/docs/features/web-ui-feedback.mdx b/fern/docs/features/web-ui-feedback.mdx index 798f2a5..c64b80d 100644 --- a/fern/docs/features/web-ui-feedback.mdx +++ b/fern/docs/features/web-ui-feedback.mdx @@ -11,75 +11,9 @@ Each suggestion includes a title and description that explains what changes are Suggestion description with markdown formatting showing bold headers and bullet lists -### Ways to provide feedback +### Providing feedback -Provide feedback on suggestions through request changes, inline comments, overall comments, or close feedback. Each method lets you request immediate changes or save preferences for future suggestions. - -### 1. Request Changes - -Use the **Request Changes** button at the top of any suggestion to request updates. Provide multiple pieces of feedback at once, and Promptless will address them all together. - - - Request Changes button with text field and example suggestions - - -The interface includes common examples to get you started: -- "Put X file's content as a section in Y file instead of making it its own file" -- "Make the tone more conversational, and do that for all future suggestions too" -- "I always want changelog entries in their own suggestion—please move" - -Click **Submit Request** to process all your feedback. - -### 2. Inline Comments - -Add comments to specific files or sections within a suggestion for targeted feedback. Click **Edit** or **Add Comment** on any file to provide context-specific input. - - - Inline comment buttons showing Edit and Add Comment options - - -When you add an inline comment, you'll see a feedback panel with two options: - - - Feedback panel with checkboxes for immediate changes and future learning - - -**Request changes on this suggestion**: Promptless will apply your feedback to the current suggestion. You can add multiple comments and submit them all at once. - -**Remember feedback for future suggestions**: Promptless saves your preferences and applies them to future documentation. This helps it learn your style and standards over time. - - **Examples of feedback to remember:** - - "Always include code examples for API endpoints" - - "Use active voice instead of passive voice" - - "Include troubleshooting sections for configuration guides" - -### 3. Overall Comments - -Leave general feedback about a suggestion without targeting a specific file. This is useful for high-level guidance or when your feedback applies to the entire suggestion. - - - Overall comments section with text field and feedback options - - -Like inline comments, you can choose whether to request immediate changes or remember the feedback for future suggestions. - -### 4. Close Suggestion Feedback - -When closing a suggestion, provide feedback about why you're rejecting it. This helps Promptless improve future suggestions. - - - Close suggestion dialog with reason checkboxes and optional feedback field - - -Select one or more reasons: -- "I copied this change into my docs editor" -- "This change is incorrect" -- "This change is too insignificant" -- "This change was covered in another Promptless suggestion" -- "This is already in my docs" -- "This change is self-explanatory and doesn't need docs" - -You can also provide additional context in the feedback field. Check "Remember this feedback for future suggestions" to save your preferences. +Promptless offers several ways to provide feedback on suggestions. Learn about all available feedback methods in the [Providing Feedback](/features/providing-feedback) guide. ### Triggers page