Skip to content

chore(readme): add UTM tracking params to download links#1559

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
graycyrus:chore/utm-tracking-readme
May 12, 2026
Merged

chore(readme): add UTM tracking params to download links#1559
senamakel merged 1 commit into
tinyhumansai:mainfrom
graycyrus:chore/utm-tracking-readme

Conversation

@graycyrus
Copy link
Copy Markdown
Contributor

@graycyrus graycyrus commented May 12, 2026

Summary

  • Appends ?utm_source=github&utm_medium=readme to the two tinyhumans.ai/openhuman links in README.md so we can track traffic from the repo.

Closes #1557

Test plan

  • Verify the markdown link on line 33 renders correctly and points to the UTM-tagged URL
  • Verify the code comment on line 36 contains the UTM-tagged URL

Summary by CodeRabbit

  • Documentation
    • Updated the "install or get started" section with revised installation instructions and clearer formatting for downloading or running the application.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

📝 Walkthrough

Walkthrough

The README installation instructions are updated to append UTM tracking parameters to the download link, enabling traffic attribution from the GitHub repository and README to the download destination.

Changes

README Download Link Tracking

Layer / File(s) Summary
Download link UTM tracking parameters
README.md
Added ?utm_source=github&utm_medium=readme query parameters to both the markdown link and the inline code comment referencing the tinyhumans.ai/openhuman download page in the get-started instructions (lines 33–36).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🐰 A README update, small and neat,
Tracking params make the flow complete,
UTM tags now mark the way,
From GitHub's readme to the fray,
Analytics dance, hooray, hooray! 📊✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding UTM tracking parameters to download links in the README file.
Linked Issues check ✅ Passed The PR meets all requirements from issue #1557: adds UTM parameters to both occurrences of the tinyhumans.ai/openhuman link on lines 33 and 36.
Out of Scope Changes check ✅ Passed All changes are directly related to the stated objective of adding UTM tracking parameters to README links; no extraneous modifications detected.
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.


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

@graycyrus graycyrus marked this pull request as ready for review May 12, 2026 14:26
@graycyrus graycyrus requested a review from a team May 12, 2026 14:26
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 36: Fix the grammatical error in the README sentence by replacing the
phrase "run in from your terminal" with "run it from your terminal" (update the
line that currently reads "# Download DMG, EXEs over at
https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run in
from your terminal" to use "run it from your terminal"); ensure spacing and
punctuation remain consistent with surrounding text.
- Line 35: The fenced code block that currently begins with ``` and contains the
line "# Download DMG, EXEs over at
https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run in
from your terminal" needs a language specifier to satisfy MD040; change the
opening fence from ``` to ```bash so the block reads as a bash snippet and
enables proper syntax highlighting.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: dadb7276-7abd-4e50-8192-faea9d6ebc02

📥 Commits

Reviewing files that changed from the base of the PR and between 15c7442 and 9b2a237.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
To install or get started, either download from the website over at [tinyhumans.ai/openhuman](https://tinyhumans.ai/openhuman) or run
To install or get started, either download from the website over at [tinyhumans.ai/openhuman](https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme) or run

```
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.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language specifier to fenced code block.

The code block should specify a language for proper syntax highlighting and to satisfy markdownlint rules.

📝 Proposed fix
-```
+```bash
 # Download DMG, EXEs over at https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run in from your terminal

As per coding guidelines, the static analysis tool markdownlint-cli2 flagged this as MD040 (fenced-code-language).

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 35-35: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 35, The fenced code block that currently begins with ```
and contains the line "# Download DMG, EXEs over at
https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run in
from your terminal" needs a language specifier to satisfy MD040; change the
opening fence from ``` to ```bash so the block reads as a bash snippet and
enables proper syntax highlighting.

Comment thread README.md

```
# Download DMG, EXEs over at https://tinyhumans.ai/openhuman or run in from your terminal
# Download DMG, EXEs over at https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run in from your terminal
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.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix grammatical error in comment.

The phrase "run in from your terminal" contains an extra word. It should be either "run it from your terminal" or "run from your terminal".

✏️ Proposed fix
-# Download DMG, EXEs over at https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run in from your terminal
+# Download DMG, EXEs over at https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run it from your terminal
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Download DMG, EXEs over at https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run in from your terminal
# Download DMG, EXEs over at https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run it from your terminal
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 36, Fix the grammatical error in the README sentence by
replacing the phrase "run in from your terminal" with "run it from your
terminal" (update the line that currently reads "# Download DMG, EXEs over at
https://tinyhumans.ai/openhuman?utm_source=github&utm_medium=readme or run in
from your terminal" to use "run it from your terminal"); ensure spacing and
punctuation remain consistent with surrounding text.

@senamakel senamakel merged commit b9f1c08 into tinyhumansai:main May 12, 2026
19 of 22 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.

Add UTM tracking params to tinyhumans.ai/openhuman links in README

2 participants