Skip to content

DRAFT: front-page usage-logging notice (merge only together with the telemetry book.toml keys) - #27

Draft
cyrus- wants to merge 2 commits into
masterfrom
telemetry/front-page-notice
Draft

cyrus- wants to merge 2 commits into
masterfrom
telemetry/front-page-notice

Conversation

@cyrus-

@cyrus- cyrus- commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Draft. Lands only when usage logging is turned on for the tutorial.

With the notice consent mode (rustviz/rustviz#1120) there is no banner and nothing injected into the pages: the book's own text is the notice. This adds that text at the bottom of the front page (src/motivation.md): what is recorded, a link to https://rustviz.github.io/privacy/, and a "Your data" link to https://rustviz.github.io/privacy/#your-data (the privacy page's section with the reader's ID and a Turn off button; the tutorial and the playground share the rustviz.github.io origin, so turning off there applies here). The study sentence is a MAINTAINER placeholder to replace once the IRB has decided.

Must merge together with the book.toml telemetry keys, not before, i.e. when the maintainer turns telemetry on:

[preprocessor.rustviz]
telemetry-endpoint = "https://<collector>"
telemetry-consent = "notice"
telemetry-surface = "tutorial"
telemetry-privacy-url = "https://rustviz.github.io/privacy/"
telemetry-respect-privacy-signals = false   # we never sell or share the data; only Turn off stops logging

Without those keys the paragraph would claim logging that is not happening, and the "Your data" link leads to a section that says logging is not enabled. Needs the mdbook-rustviz release that includes #1120.

Checked: built with the #1120 preprocessor against a local mock collector; no banner or footer is drawn, events flow, and Turn off on the privacy page sent one withdraw and stopped the open tutorial page (checked in headless Chrome, with the playground and the tutorial served from one origin).

🤖 Generated with Claude Code

https://claude.ai/code/session_01Cm3BaipF8V6TKkdjBUQn8Q

…etry book.toml keys)

Adds a short paragraph at the bottom of the front page saying the site
records how it is used for research, linking the privacy page and a
"Your data" link (href="#rv-your-data", handled by rv-telemetry.js), plus
a MAINTAINER placeholder for the study sentence. Inert until the book
turns telemetry on.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Cm3BaipF8V6TKkdjBUQn8Q
@cyrus- cyrus- added the enhancement New feature or request label Nov 17, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant