opensafely / opensafely/documentation
Consider adding feedback routes for documentation pages
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
mkdocs-material has a means for adding a user feedback widget.
In the docs for mkdocs-material, someone responding "no" to the "Was this page helpful?" prompt at the bottom of a page gets a prompt to fill in a Google Form to supply detailed feedback. This is currently an "insider" only feature: we'd have to wait for a little bit longer for this feature to be funded in the open source version.
This talk from a Twilio developer illustrates the usefulness of direct feedback for documentation.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No repository file, test, or entry point is named. Start by reviewing how the documentation site is configured and the open-source limitations described in the mkdocs-material feedback documentation. Define the desired feedback flow and destination, then verify it works on documentation pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100