[Docs]: Add feedback widget in Documenation #697
Assignees
Labels
Documentation
Improvements or additions to documentation
High
This issue blocks a user from building or impacts a lot of users
Ready for Doc Team
User Education Pod
Issues related to user education
Comments
danciaclara
added
Documentation
|
@danciaclara - The link uses Docusaurus Footer. But as we are going to remove the footer as part of #519, we will create a new component to add this. |
danciaclara
added
High
danciaclara
added
the
High
|
Based on this discussion - We'll need to evaluate the best possible way forward. Moving it back to Backlog ready pipeline. |
14 tasks
jnikhila
added a commit
that referenced
this issue
Sep 7, 2023
## Changes
- Added a feedback widget
- Available on the Table of contents bar
- A 'No' will show a survey link to users to gather more info.
## Doc ticket
Fixes - #697
## Checklist
I have:
- [ ] run the content through Grammarly
- [ ] linked to sample apps when relevant
- [ ] added the meta description for each page in the PR
- [ ] minimized the callouts and added only when necessary
- [ ] added the `queryString` parameter to the Tabs (if used)
- [ ] masked PII in images. For example, login credentials, account
details, and more
- [ ] added images only when necessary
- [ ] deleted the images that are no longer used for the updated pages
in the PR
- [x] followed the image file naming convention while renaming or adding
new images. (Use lowercase letters, dashes between words, and be as
descriptive as possible)
- [ ] used the `<figure/>` tag instead of a markdown representation for
images
- [ ] added the `<figcaption/>` tag to add a caption to the image
- [x] added the `alt` attribute in the `<img/>` tag
- [ ] verified and updated the cross-references or created redirect
rules for the changed or removed content
- [ ] reviewed and applied the style changes for UI formatting. For
example, Bold the UI elements(Buttons on screen) used in the doc.
---------
Co-authored-by: danciaclara <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is there an existing issue for this?
Engineering Ticket Link
na
Release Date
na
Release Number
na
First Draft
No response
Loom video
No response
Discord/slack/intercom Link if needed
No response
PRD
No response
Test plan/cases
No response
Use cases or user requests
In Gitbook we had a feedback widget with emojis where users could rate whether the page is useful.
This is very important information for us to track. Docusaurus has this feature planned in their roadmap, but until then, we should build this using Swizzle.
https://happyreact.com/blog/feedback-widget-in-docusaurus
The text was updated successfully, but these errors were encountered: