Update Fathom extension docs for current UI and version - #23
Conversation
WalkthroughThe Fathom analytics extension documentation was updated, including a version increment from 5.0 to 5.0.2, revised integration instructions reflecting updated UI navigation paths within the MainWP Dashboard, terminology adjustments, and updated route references. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (3)
add-ons/analytics/fathom-extension.mdx (3)
80-85: Consider updating screenshot asset naming to match the new “Add Account” wording.The step now references Add Account, but the image path still uses
fathom-add-sites-page.png. Even if the image is correct, the filename can mislead future doc maintenance.Suggested doc-maintenance tweak
- +(If you keep the current file, consider at least renaming in the media folder in a follow-up PR for consistency.)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@add-ons/analytics/fathom-extension.mdx` around lines 80 - 85, The screenshot filename is inconsistent with the updated Step title ("Navigate to MainWP Dashboard > Add-ons > Analytics > Fathom > Add Account")—update the image reference in the Step that currently points to fathom-add-sites-page.png to a filename that reflects "add-account" (or rename the media asset to match and update the path in the Step). Locate the Step containing the image reference (the Paste in the API token... Step) and change the image path string to the new, consistently named asset so docs and media stay aligned.
122-122: Slight duplication in widget settings guidance.Both sections repeat near-identical “enable/disable + rearrange” guidance. Consider standardizing one phrasing pattern to reduce drift over time.
Also applies to: 130-130
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@add-ons/analytics/fathom-extension.mdx` at line 122, Two nearly identical sentences at the widget settings guidance (the sentence starting "You can disable and enable widgets..." at the locations around lines 122 and 130) duplicate the same enable/disable + rearrange guidance; consolidate them to a single standardized sentence or phrasing and replace both instances with that canonical line (or keep one and remove the other), ensuring references still point to [Page Settings](/getting-started/mainwp-user-interface) and the ability to rearrange widgets is preserved; update both occurrences so they use the exact same wording to avoid future drift.
89-89: Tighten phrasing for directness.“You will need to” is a bit wordy for task instructions; “need to” reads cleaner.
Concise wording tweak
-The Fathom Extension doesn't allow you to insert the Fathom Analytics tracking code on your child sites. To do that, you will need to add the code manually or use a third-party plugin. +The Fathom Extension doesn't allow you to insert the Fathom Analytics tracking code on your child sites. To do that, you need to add the code manually or use a third-party plugin.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@add-ons/analytics/fathom-extension.mdx` at line 89, Update the wording in the Fathom Extension documentation sentence that currently reads "To do that, you will need to add the code manually or use a third-party plugin." — replace "you will need to" with the more direct "you need to" so the sentence reads "To do that, you need to add the code manually or use a third-party plugin."; edit the string in the add-ons/analytics/fathom-extension.mdx content where that sentence appears (the explanatory sentence about inserting Fathom Analytics tracking code).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@add-ons/analytics/fathom-extension.mdx`:
- Around line 80-85: The screenshot filename is inconsistent with the updated
Step title ("Navigate to MainWP Dashboard > Add-ons > Analytics > Fathom > Add
Account")—update the image reference in the Step that currently points to
fathom-add-sites-page.png to a filename that reflects "add-account" (or rename
the media asset to match and update the path in the Step). Locate the Step
containing the image reference (the Paste in the API token... Step) and change
the image path string to the new, consistently named asset so docs and media
stay aligned.
- Line 122: Two nearly identical sentences at the widget settings guidance (the
sentence starting "You can disable and enable widgets..." at the locations
around lines 122 and 130) duplicate the same enable/disable + rearrange
guidance; consolidate them to a single standardized sentence or phrasing and
replace both instances with that canonical line (or keep one and remove the
other), ensuring references still point to [Page
Settings](/getting-started/mainwp-user-interface) and the ability to rearrange
widgets is preserved; update both occurrences so they use the exact same wording
to avoid future drift.
- Line 89: Update the wording in the Fathom Extension documentation sentence
that currently reads "To do that, you will need to add the code manually or use
a third-party plugin." — replace "you will need to" with the more direct "you
need to" so the sentence reads "To do that, you need to add the code manually or
use a third-party plugin."; edit the string in the
add-ons/analytics/fathom-extension.mdx content where that sentence appears (the
explanatory sentence about inserting Fathom Analytics tracking code).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: ab560be5-950b-459c-9c69-115bb2ee636c
📒 Files selected for processing (1)
add-ons/analytics/fathom-extension.mdx
Summary
5.0to5.0.2Testing
Summary by CodeRabbit