8000 docs(telemetry): DO_NOT_TRACK needs a non-empty value; link spec 25 by URL by mitodrummer · Pull Request #2209 · gominimal/minimal · GitHub
[go: up one dir, main page]

Skip to content

docs(telemetry): DO_NOT_TRACK needs a non-empty value; link spec 25 by URL - #2209

Merged
norrietaylor merged 1 commit into
mainfrom
docs/telemetry-opt-out-wording
Oct 17, 2026
Merged

norrietaylor merged 1 commit into
mainfrom
docs/telemetry-opt-out-wording

Conversation

@mitodrummer
@mitodrummer mitodrummer commented Oct 14, 2026 •
Copy link
Copy Markdown
Member

Two lines in docs/reference/telemetry.md, both raised by reviewers on the website's docs sync (gominimal/webapp#879), where this page is published verbatim:

  • The "Turning it off" table said any value of DO_NOT_TRACK disables telemetry; the paragraph under it says the value must be non-empty. The table now says non-empty.
  • The "spec 25" link was relative to docs/specs/, which the website sync never carries, so the published page 404ed on it. It now links the file by repository URL, which resolves in the repo and on the site.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Wm1YgysmSMp3upJQvZJHwt

Summary by CodeRabbit

  • Documentation
    • Updated the telemetry reference to link directly to the spec 25 page on GitHub.
    • Clarified that telemetry is disabled when DO_NOT_TRACK contains any non-empty value. Empty values do not meet this opt-out condition.

…pec 25 by URL

The opt-out table said any value of DO_NOT_TRACK disables telemetry while
the paragraph below it says the value must be non-empty; the table now
agrees with the paragraph. The spec 25 link was relative to docs/specs,
which the website's docs sync never carries, so the synced page 404ed on
it; an absolute repository URL resolves in both places.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Wm1YgysmSMp3upJQvZJHwt
@mitodrummer
mitodrummer requested a review from a team as a code owner October 14, 2026 18:22
@coderabbitai
coderabbitai Bot commented Oct 14, 2026 •
Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Essentials
  • Run ID: 2fb52990-b7ab-47fa-9ebe-fd533b58dad4
📥 Commits

Reviewing files that changed from the base of the PR and between 598e6d8 and 862f833.

📒 Files selected for processing: 1
  • docs/reference/telemetry.md

Included review availability: This review used your included allowance. 3 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

📝 Walkthrough

The telemetry reference now links to spec 25 with an absolute GitHub URL. It also states that a non-empty DO_NOT_TRACK value disables telemetry.

Changes: Telemetry reference

Layer / File(s) Summary
Update telemetry reference
docs/reference/telemetry.md
The specification link now uses an absolute GitHub URL. The opt-out description now specifies that DO_NOT_TRACK must be non-empty.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Suggested reviewers: bryan-minimal

Merge Risk: ⚪ Minimal · up to 862f8

This change clarifies the existing non-empty DO_NOT_TRACK behavior and links to the existing telemetry specification. No material merge risk remains.

Pre-merge checks: Passed 5
Passed Passed checks: 5 passed
Check name Status Explanation
Title check Passed The title clearly and concisely describes both documentation changes. It uses the expected Conventional Commit format and identifies the affected telemetry behavior and link.
Description check Passed The description explains what changed, why it changed, and references the related issue. The Testing section is not completed, but the description is otherwise substantially complete for this document…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

Some tools did not complete. Review the errors below.

🔧 Vale (3.22.0)

{
"Line": 0,
"Path": "",
"Text": "E100 [loadStyles] Runtime error\n\nstyle 'ste' does not exist on StylesPath\n\nExecution stopped with code 1.",
"Code": "E100",
"Span": 0
}

A rabbit checks the link with care,
Then finds the opt-out wording there.
A value empty does not apply,
A non-empty one can say goodbye.
The reference hops, precise and bright.

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

@minimal-foundry
minimal-foundry Bot commented Oct 14, 2026 •
Copy link
Copy Markdown
Contributor

Approved: no findings at 862f8335dc8c.

Nothing to do.

Clobber: none — git log shows no recent fix to this file reverted.

@minimal-foundry minimal-foundry 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.

correctness

minimal-review — approved

Verdict APPROVE — No findings.

security

minimal-review — approved

Verdict APPROVE — No findings.

supply-chain

minimal-review — approved

Verdict APPROVE — No findings.

Panel: 3 of 3 personas ran (correctness, security, supply-chain).

@minimal-foundry minimal-foundry Bot added the review:approved minimal-review approved the current head label Oct 14, 2026
@bryan-minimal
Copy link
Copy Markdown
Member

Heads-up so we do not collide: #2207 (the OTel follow-ups, item 7 of #2202) carries the same change to the DO_NOT_TRACK row in docs/reference/telemetry.md ("any non-empty value"). Whichever lands second will conflict on that one line and can just drop its copy; if yours goes first I will rebase #2207 over it.

@norrietaylor norrietaylor left a comment
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Approved.

@norrietaylor
norrietaylor merged commit cb46bda into main Oct 17, 2026
36 checks passed
@norrietaylor
norrietaylor deleted the docs/telemetry-opt-out-wording branch October 17, 2026 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review:approved minimal-review approved the current head

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

0