From 884c3cd7e602169b3ce56b1c41929017ae5da6cd Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 21:27:42 +0000 Subject: [PATCH 1/2] Add dedicated feedback page documenting three ways to give feedback --- fern/docs.yml | 2 + fern/docs/features/giving-feedback.mdx | 144 +++++++++++++++++++++++++ fern/docs/features/index.mdx | 4 + 3 files changed, 150 insertions(+) create mode 100644 fern/docs/features/giving-feedback.mdx diff --git a/fern/docs.yml b/fern/docs.yml index f93e53c..606f966 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -46,6 +46,8 @@ navigation: path: ./docs/features/github-pr-comments.mdx - page: Using the Web Interface path: ./docs/features/web-ui-feedback.mdx + page: Giving Feedback to Promptless + path: ./docs/features/giving-feedback.mdx - section: Integrations icon: fa-regular fa-plug path: ./docs/integrations/index.mdx diff --git a/fern/docs/features/giving-feedback.mdx b/fern/docs/features/giving-feedback.mdx new file mode 100644 index 0000000..ed37fb9 --- /dev/null +++ b/fern/docs/features/giving-feedback.mdx @@ -0,0 +1,144 @@ +--- +title: Giving Feedback to Promptless +description: Learn how to give feedback to Promptless and help it improve documentation quality over time +--- + +Promptless learns from your feedback to improve documentation suggestions and understand your team's preferences. You can provide feedback through the web interface or directly on GitHub PRs. + +## Three ways to give feedback + +### 1. Request changes in the web interface + +Use this when you want Promptless to modify the current documentation suggestion immediately. + + + + Open your suggestion in the Promptless web interface. + + + + Highlight any text you want to comment on and add your feedback in the comment box. + + + + Check the box **"Request changes on this suggestion"** and submit your feedback. + + + +Promptless will process your comments and update the documentation suggestion based on your instructions. You can add multiple comments before submitting. + +**Examples:** + +```txt wordWrap +Add a code example showing the API request +``` + +```txt wordWrap +Move this section to the beginning of the page +``` + +```txt wordWrap +Change the endpoint from /v1/users to /v2/users +``` + +### 2. Remember feedback for future suggestions + +Use this when you want Promptless to learn your preferences and apply them to future documentation suggestions. + + + + Open your suggestion in the Promptless web interface. + + + + Highlight specific text you want to provide feedback on and add your feedback in the comment box. + + + + Check the box **"Remember feedback for future suggestions"** and submit your feedback. + + + +This helps Promptless learn your documentation standards and style preferences over time. The feedback won't change the current suggestion immediately, but will influence future documentation. + +**Examples:** + +```txt wordWrap +Always include code examples for API endpoints +``` + +```txt wordWrap +Use active voice instead of passive voice +``` + +```txt wordWrap +Include troubleshooting sections for configuration guides +``` + + +You can check both boxes to apply changes immediately AND save the feedback for future suggestions. + + +### 3. Comment on GitHub PRs + +Use this when you're reviewing a documentation PR that Promptless opened and want to request follow-up changes. + +**Individual comments** + +Leave individual comments on specific lines or sections of the documentation PR for targeted feedback. + +Tag Promptless (@Promptless) in the comment (Note: It won't show up in auto-complete), write your instruction, and click "Add single comment" to submit your instruction to Promptless. + + +When using single comments, Promptless doesn't yet have the ability to look at other previous comments. So instructions like "Same here" wouldn't work. You can either spell out the instruction completely, or use the PR review method below, where Promptless will have context on other comments in the same review. + + +**PR reviews** + +Start a review to provide multiple pieces of feedback that Promptless can handle all at once. + + + + Click "Review changes" to begin a review, or when adding an in-line comment, select "Start a review" instead of "Add single comment". + + + + Add comments throughout the PR. You don't have to tag Promptless in any of them. + + + + Click "Finish your review", and in the text box, tag Promptless (@Promptless). Promptless will address all your review feedback at once. + + + +**Examples:** + +```txt wordWrap +Please add a section about error handling +``` + +```txt wordWrap +This example should use TypeScript instead of JavaScript +``` + +```txt wordWrap +Add a note that this feature requires admin permissions +``` + +## Choosing the right method + + + + Use **Request changes** in the web interface when you need quick updates to the current suggestion. + + + + Use **Remember feedback** when you want to teach Promptless your team's documentation standards. + + + + Use **GitHub comments** when you're already reviewing the PR in your normal workflow. + + + +Need help? 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..e3ad147 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. + + + Learn how to give feedback through the web interface or GitHub PRs to help Promptless improve and learn your team's preferences. + From eefed1b06bdc2cf3c78c064498d06ce537bedc90 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 21:30:41 +0000 Subject: [PATCH 2/2] Sync documentation updates --- fern/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs.yml b/fern/docs.yml index 606f966..376eac7 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -46,7 +46,7 @@ navigation: path: ./docs/features/github-pr-comments.mdx - page: Using the Web Interface path: ./docs/features/web-ui-feedback.mdx - page: Giving Feedback to Promptless + - page: Giving Feedback to Promptless path: ./docs/features/giving-feedback.mdx - section: Integrations icon: fa-regular fa-plug