Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
74 changes: 74 additions & 0 deletions fern/docs/features/providing-feedback.mdx
Original file line number Diff line number Diff line change
@@ -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.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/request-changes-button-0c851bb3.png" alt="Request Changes button with text field and example suggestions" />
</Frame>

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.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/inline-comment-add-button-9b669423.png" alt="Inline comment buttons showing Edit and Add Comment options" />
</Frame>

When you add an inline comment, you'll see a feedback panel with two options:

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/feedback-panel-modal-48d7ca29.png" alt="Feedback panel with checkboxes for immediate changes and future learning" />
</Frame>

**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.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/overall-comments-section-c02f7cfe.png" alt="Overall comments section with text field and feedback options" />
</Frame>

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.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/close-suggestion-feedback-2881d67c.png" alt="Close suggestion dialog with reason checkboxes and optional feedback field" />
</Frame>

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).
27 changes: 2 additions & 25 deletions fern/docs/features/web-ui-feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,32 +11,9 @@ Each suggestion includes a title and description that explains what changes are
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/suggestion-description-markdown-rendering-54a81da8.png" alt="Suggestion description with markdown formatting showing bold headers and bullet lists" />
</Frame>

### Comment and feedback
### Providing feedback

Select to highlight specific portions of documentation to provide targeted comment or feedback.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/web-ui-add-comment-button-1759356264.png" alt="Add Comment button in web interface" />
</Frame>

When providing feedback through the web interface, you'll see two checkbox options that control how your feedback is processed:

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/web-ui-feedback-panel-1759356264.png" alt="Feedback panel showing two checkbox options" />
</Frame>

**1. Request changes on this suggestion**

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.

**2. Remember feedback for future suggestions**

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.

**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"
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

Expand Down