Skip to content

[AAASM-3555] 👍 (docs): Add "Was this page helpful?" feedback widget#168

Merged
Chisanan232 merged 1 commit into
masterfrom
v0.0.1/AAASM-3555/mkdocs_feedback
Jun 22, 2026
Merged

[AAASM-3555] 👍 (docs): Add "Was this page helpful?" feedback widget#168
Chisanan232 merged 1 commit into
masterfrom
v0.0.1/AAASM-3555/mkdocs_feedback

Conversation

@Chisanan232

Copy link
Copy Markdown
Contributor

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 adds extra.analytics.feedback with two ratings. When configured, mkdocs-material renders the widget at the bottom of every page and automatically sends a GA4 feedback event carrying the chosen rating's data value (no custom JS/CSS).

  • Positive rating (material/emoticon-happy-outline, "This page was helpful", data: 1) with a thank-you note.
  • Negative rating (material/emoticon-sad-outline, "This page could be improved", data: 0) whose note links to a pre-filled GitHub issue (labels docs,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

  • 📚 Documentation update

Breaking Changes

  • No

Related Issues

  • Related JIRA ticket: AAASM-3555
  • Related GitHub issues: #XX

Part of AAASM-3555 (python-sdk site). Builds on AAASM-3552 (analytics) + AAASM-3554 (consent).

Testing

Describe the testing performed for this PR:

  • Manual testing performed
  • No tests required (explain why)

Config-only docs change — no unit/integration test surface. Verified by building the docs exactly as CI does (uv sync --group docs then uv run mkdocs build --strict):

  • Clean --strict build — completed with no errors (only the standard mkdocs-material 2.0 advisory notice + an unrelated pre-existing "page not in nav" info line for release/RUNBOOK.md).
  • Built site/index.html contains the widget markup: <form class="md-feedback" name="feedback"> with both rating buttons (data-md-value="1" and data-md-value="0") and their md-feedback__note blocks.
  • The negative note renders the GitHub-issue link: 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%3F with target="_blank" rel="noopener".
  • Widget also confirmed on a second page (site/configuration/index.html).
  • Existing GA4 (G-L8JTJDG8G7) and cookie-consent (data-md-component="consent") markup still present.
  • GA reporting can be confirmed at runtime in GA4 DebugView: clicking a rating fires a feedback event with the rating's data value.

Checklist

  • Code follows project style guidelines
  • Self-review completed
  • Comments added for complex logic
  • Documentation updated if needed
  • All tests passing

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Chisanan232

Copy link
Copy Markdown
Contributor Author

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 extra.analytics.feedback with a happy (data: 1) / sad (data: 0) rating pair; the sad rating's note links to a pre-filled GitHub issue. Config-only, no custom JS/CSS, no new dependency. 1 small commit.

🔬 Verification. I built this branch locally (uv sync --group docs + mkdocs build) and confirmed the rendered widget in the built HTML:

  • <form class="md-feedback"> with title "Was this page helpful?" and both ratings (data-md-value="1" and ="0").
  • The sad-rating note renders the pre-filled GitHub issue link https://github.com/ai-agent-assembly/python-sdk/issues/new?labels=docs,feedback&title=Docs%20feedback&body=Page%3A%20… with target="_blank" + rel="noopener".

Note on live click-through: mkdocs-material gates the feedback widget (and its GA feedback event) behind its native cookie-consent acceptance (AAASM-3554's extra.consent) and the Material analytics integration — i.e. the widget intentionally stays hidden until the visitor accepts analytics, then Material fires the feedback event itself. That reveal/emit path is Material's own well-tested code; our change is the declarative config that wires it up, verified present and correct in the built output above. (This is the same opt-in posture the other four sites enforce via Consent Mode.)

Ready for approval + merge.

@Chisanan232 Chisanan232 merged commit 8bafe17 into master Jun 22, 2026
6 checks passed
@Chisanan232 Chisanan232 deleted the v0.0.1/AAASM-3555/mkdocs_feedback branch June 22, 2026 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant