Skip to content

docs: Add feedback guidance section to web UI documentation #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add feedback guidance section to web UI documentation #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions fern/docs/features/web-ui-feedback.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,34 @@ When providing feedback through the web interface, you'll see two checkbox optio
- "Use active voice instead of passive voice"
- "Include troubleshooting sections for configuration guides"

## Choosing the Right Feedback Method

Understanding when and how to provide feedback helps Promptless improve both your immediate documentation needs and the platform's overall capabilities.

### Suggestion-Level Feedback

Use the web interface feedback options (described above) when you need to:

- **Make specific edits to current suggestions**: Request targeted changes to the documentation draft you're reviewing
- **Set future documentation preferences**: Establish guidelines that Promptless should remember for upcoming documentation updates (e.g., "only update this section when code changes in the authentication module")
- **Provide style or formatting corrections**: Help Promptless learn your organization's documentation standards

<Tip>
This type of feedback is best for tactical improvements that directly enhance the current suggestion or establish patterns for similar future documentation.
</Tip>

### General Platform Feedback

For broader feedback about Promptless capabilities or feature requests, reach out through your team's communication channels or contact support:

- **Feature requests**: Suggestions for new Promptless capabilities or integrations
- **Overall performance feedback**: General observations like "Promptless could better handle technical specifications" or "API documentation needs more context"
- **Workflow improvements**: Ideas for enhancing the documentation generation process

<Note>
This type of feedback is best for strategic improvements that could benefit all Promptless users or require platform-level changes.
</Note>

This dual approach ensures your immediate documentation needs are addressed while contributing to Promptless's continuous improvement.

Need help with the web interface? Contact us at [[email protected]](mailto:[email protected]).