opensafely / opensafely/documentation
Consider implementing Material for MkDocs feedback option
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 48
- Forks
- 10
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 17
Description
v8.4.0 of Material for MkDocs enables feedback features.
This could be useful for gathering user feedback on the documentation; maybe we should try it out?
Current questions:
- Do we want an actual feedback form? How would that be implemented; Google Form?
- Can we get some useful quantifiable information from positive or negative ratings via Plausible (which I'm not too familiar with, but maybe custom event goals?
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
Start with the Material for MkDocs feedback features documentation linked in the issue, then review the questions about a feedback form and Plausible custom event goals. A complete result would define the feedback approach and its measurable outcome before implementation; no repository file or test is named here.
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