To tighten the feedback loop, let a studier report a wrong/confusing question in one click while practicing — the fastest way for us to catch bad content and for new users to make their first contribution.
Idea: on each question in the study site (docs/), add a small "Report an issue with this question" link that deep-links to a pre-filled GitHub issue, e.g.:
https://github.com/DMDaudio/OpenMat/issues/new?title=Content%20report:%20<question-id>&body=<template>
with the question id (and ideally section/topic) interpolated so the report is actionable without the user typing anything.
Scope / good-first-issue notes:
- Frontend only, no build changes required — the question
id is already in docs/data/content.json and rendered by docs/app.js.
- Bonus: add a matching issue template under
.github/ISSUE_TEMPLATE/ for content reports so the pre-filled body maps to it.
- Keep it unobtrusive (small link/icon near the explanation), and it must work with no account beyond a free GitHub login.
Happy to advise on where in app.js the question renders. Comment to claim.
Maintainers: suggest adding good first issue.
To tighten the feedback loop, let a studier report a wrong/confusing question in one click while practicing — the fastest way for us to catch bad content and for new users to make their first contribution.
Idea: on each question in the study site (
docs/), add a small "Report an issue with this question" link that deep-links to a pre-filled GitHub issue, e.g.:with the question
id(and ideally section/topic) interpolated so the report is actionable without the user typing anything.Scope / good-first-issue notes:
idis already indocs/data/content.jsonand rendered bydocs/app.js..github/ISSUE_TEMPLATE/for content reports so the pre-filled body maps to it.Happy to advise on where in
app.jsthe question renders. Comment to claim.Maintainers: suggest adding
good first issue.