[AAASM-3555] 👍 (docs): Add "Was this page helpful?" feedback widget#168
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Claude Code — review result ✅ CI green — all 4 checks pass (Analyze python, CodeQL, Build documentation). No fails to ignore. Scope vs AAASM-3555 (python-sdk mkdocs site) — covered. Enables mkdocs-material's native 🔬 Verification. I built this branch locally (
Note on live click-through: mkdocs-material gates the feedback widget (and its GA Ready for approval + merge. |
Description
Enables Material for MkDocs' native "Was this page helpful?" page-feedback widget on the python-sdk docs site. This is a config-only change to
mkdocs.yml: it addsextra.analytics.feedbackwith two ratings. When configured, mkdocs-material renders the widget at the bottom of every page and automatically sends a GA4feedbackevent carrying the chosen rating'sdatavalue (no custom JS/CSS).material/emoticon-happy-outline, "This page was helpful",data: 1) with a thank-you note.material/emoticon-sad-outline, "This page could be improved",data: 0) whose note links to a pre-filled GitHub issue (labelsdocs,feedback, page-URL placeholder) so the reader can explain — no free-text is ever sent to GA. The link opens in a new tab (target="_blank" rel="noopener").Builds on AAASM-3552 (GA4 analytics, property
G-L8JTJDG8G7) and AAASM-3554 (native cookie-consent banner) — both remain intact and verified in the built HTML. No new dependency.Type of Change
Breaking Changes
Related Issues
Part of AAASM-3555 (python-sdk site). Builds on AAASM-3552 (analytics) + AAASM-3554 (consent).
Testing
Describe the testing performed for this PR:
Config-only docs change — no unit/integration test surface. Verified by building the docs exactly as CI does (
uv sync --group docsthenuv run mkdocs build --strict):--strictbuild — completed with no errors (only the standard mkdocs-material 2.0 advisory notice + an unrelated pre-existing "page not in nav" info line forrelease/RUNBOOK.md).site/index.htmlcontains the widget markup:<form class="md-feedback" name="feedback">with both rating buttons (data-md-value="1"anddata-md-value="0") and theirmd-feedback__noteblocks.https://github.com/ai-agent-assembly/python-sdk/issues/new?labels=docs,feedback&title=Docs%20feedback&body=Page%3A%20(paste%20the%20page%20URL)%0A%0AWhat%20could%20be%20improved%3Fwithtarget="_blank" rel="noopener".site/configuration/index.html).G-L8JTJDG8G7) and cookie-consent (data-md-component="consent") markup still present.feedbackevent with the rating'sdatavalue.Checklist