Skip to content

fix: point the docs links to the current Hyve docs pages with UTMs - #306

Merged
poonam279 merged 1 commit into
developmentfrom
fix/docs-links-utm
Nov 9, 2026
Merged

poonam279 merged 1 commit into
developmentfrom
fix/docs-links-utm

Conversation

@poonam279

Copy link
Copy Markdown

Summary

The dashboard's two docs links use old HelpScout URLs on docs.themeisle.com. They still redirect to the Hyve docs, but the redirect drops the query string, and the links sent no UTM parameters anyway, so docs visits from the plugin aren't attributed in analytics. This is part of Codeinwp/docs-site#1596 (reviewing docs links in all products).

This PR (inc/Main.php, the hyve script data):

Link Before After
Docs (header bar, dashboard "Need help?" card) /article/2009-hyve-documentation tsdk_utmify( 'https://docs.themeisle.com/hyve/hyve-documentation', 'documentation', 'dashboard' )
Learn more about Qdrant (Settings → Qdrant) /article/2066-integrate-hyve-with-qdrant tsdk_utmify( 'https://docs.themeisle.com/hyve/integrate-hyve-with-qdrant', 'qdrant', 'settings' )

The Docs link now opens https://docs.themeisle.com/hyve/hyve-documentation?utm_source=wpadmin&utm_medium=dashboard&utm_campaign=documentation&utm_content=docshyvehyve-documentation.

The record of current vs new parameters for every product is in the docs-links report: https://claude.ai/artifact/TFrbebxm6kHNpJfb7GfzR2

Testing

  • E2E: dashboard.spec.js (app shell test) checks the header's Docs href, and settings.spec.js (Qdrant form test) checks the "Learn more about Qdrant" href. Both pass with the fix and fail on the old code (they receive the /article/… URLs). The full Dashboard and Settings specs pass (22 tests).
  • composer lint (phpcs on inc/Main.php), composer phpstan and ESLint pass.
  • Both docs URLs return 200 with the UTMs (no redirect).

🤖 Generated with Claude Code

The "Docs" link (header bar and dashboard help card) and the Qdrant "Learn
more" link used old HelpScout URLs (/article/2009-…, /article/2066-…). They
redirect to the Hyve docs, but the redirect drops the query string, and the
links had no UTM parameters anyway. Both now point at the current docs pages
through tsdk_utmify().

Part of Codeinwp/docs-site#1596.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown

Plugin build for 2c05fc8 is ready 🛎️!

@poonam279
poonam279 requested a review from pirate-bot November 9, 2026 13:22

@pirate-bot pirate-bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes requested

The dashboard docs links now open the current pages with UTMs, but the readme's ThemeIsle links still lack UTM parameters.

  • readme.txt:25 — correctness The fix tags the two dashboard docs links, but the readme's ThemeIsle links still carry no UTM parameters. readme.txt:25 links [Documentation](https://docs.themeisle.com/hyve/) without attribution. The Terms, Privacy, FTP and Security links at readme.txt:144, readme.txt:178 and readme.txt:208 are also untagged. Docs visits from the plugin listing and the plugin details screen therefore stay unattributed, which is the problem this PR fixes. Add UTM parameters to each of these links. Use the same scheme as the readme's Pro links, which already carry utm_source, utm_medium and utm_campaign (for example on readme.txt:25).
Validation details
  • Files reviewed: 3/3 changed files.
  • The Hyve admin page loaded as admin with HTTP 200 and no fatal error on PHP 8.3.36 cd /workspace/checks/R1 && curl -s -b jar.txt -c jar.txt -o dash.html -w '%{http_code}\n' 'http://localhost:8080/wp-admi… (run R7, exit 0).
  • The localized hyve data held the new URLs, for example cd /workspace/checks/R1 && python3 - <<'EOF' import re,html s=open('dash.html').read() m=re.search(r'var hyve = (\{.*?\}… printed utm_source=wpadmin&utm_medium=dashboard&utm_campaign=documentation (run R9). Both values match the new test assertions.
  • tsdk_utmify() comes from the Composer-loaded SDK before the data filter runs.
Untested areas
  • The Playwright tests did not run at HEAD or at pr-base. They need npm ci, a built bundle and wp-env.

🤖 Automated review · run code-review-agent_6af1c92733e642.17089338.


🤖 Review agent — review posted ✅ on 2c05fc80 · changes requested · 1 finding · 10 min

Run code-review-agent_6af1c92733e642.17089338 · trail

@poonam279
poonam279 merged commit b758731 into development Nov 9, 2026
10 checks passed
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.

2 participants