Skip to content

Update Fathom extension docs for current UI and version - #23

Merged
bkatusic merged 1 commit into
mainfrom
docs-review/fathom-extension
Mar 24, 2026
Merged

bkatusic merged 1 commit into
mainfrom
docs-review/fathom-extension

Conversation

@bkatusic

@bkatusic bkatusic commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

Summary

  • update the documented Fathom extension version from 5.0 to 5.0.2
  • correct outdated navigation and tab labels to match the current Add-ons > Analytics > Fathom flow
  • clarify the account connection requirement and clean up related instructional wording
  • fix small text issues in step titles, alt text, and Page Settings references

Testing

  • Not run (not requested)

Summary by CodeRabbit

  • Documentation
    • Updated Fathom Analytics add-on documentation for version 5.0.2.
    • Clarified account setup and connection instructions with updated navigation paths.
    • Refined documentation clarity with improved wording and page references.

@coderabbitai

coderabbitai Bot commented Mar 24, 2026

Copy link
Copy Markdown

Walkthrough

The 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

Cohort / File(s) Summary
Fathom Analytics Documentation
add-ons/analytics/fathom-extension.mdx
Updated data-version to 5.0.2, revised integration description, changed navigation paths to reflect new UI structure (MainWP Dashboard > Add-ons > Analytics > Fathom > Add Account), adjusted terminology (e.g., "3rd party" → "third-party"), and updated route references throughout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Update Fathom extension docs for current UI and version' directly and accurately summarizes the main changes: updating documentation for UI navigation changes and version bump from 5.0 to 5.0.2.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-review/fathom-extension

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 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
-![MainWP Fathom account connection page with API token field and Connect Account button](/images/add-ons/fathom-add-sites-page.png)
+![MainWP Fathom account connection page with API token field and Connect Account button](/images/add-ons/fathom-add-account-page.png)

(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

📥 Commits

Reviewing files that changed from the base of the PR and between a455224 and 67c4c66.

📒 Files selected for processing (1)
  • add-ons/analytics/fathom-extension.mdx

@bkatusic
bkatusic merged commit 278def4 into main Mar 24, 2026
4 checks passed
@bkatusic
bkatusic deleted the docs-review/fathom-extension branch April 2, 2026 14:44
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