Skip to content

Update Signals description - #1902

Open
jborlase-snowplow wants to merge 1 commit into
mainfrom
jborlase-snowplow-patch-1
Open

Update Signals description#1902
jborlase-snowplow wants to merge 1 commit into
mainfrom
jborlase-snowplow-patch-1

Conversation

@jborlase-snowplow

Copy link
Copy Markdown
Contributor

What changed?

Why?

Reviewer guidance

AI reviews

Claude will automatically review this PR against the docs style guide.

If you have questions or want it to look again at something specific, tag @claude in a comment.

@claude

claude Bot commented Aug 4, 2026

Copy link
Copy Markdown

Style review

The diff is a single change: the description frontmatter on docs/signals/index.md. Two things are worth changing before merge, plus a couple of minor notes. No external links were added or modified, so there was nothing to link-check.

1. Marketing language in the description

"Snowplow Signals delivers real-time customer context to the ML and AI applications you're building. It combines historical user behavior with sequential, in-session user behavior to power your personalized experiences and recommendations..."

The style guide (src/pages/style-guide/llm/index.md, "Writing style") says "Never use marketing language", and CLAUDE.md ("Writing style") requires a professional, technical tone. "Delivers ... to the applications you're building" and "to power your ..." are promotional framing rather than a technical statement of what the product does. The previous description ("computes and acts on behavioral data from your pipeline") was factual, and it matched the vocabulary of the page body, which says "Snowplow Signals computes user attributes from your data".

Suggested fix, keeping the new use cases but neutral in tone:

description: "Snowplow Signals computes real-time customer attributes for your ML and AI applications, combining historical and in-session user behavior. Use it for personalized recommendations, dynamic pricing, product experimentation, and customer-facing AI agents."

2. The description is too long for its purpose

The new value is roughly 350 characters. CLAUDE.md ("Required frontmatter") specifies description as "One to two sentences for SEO." It is technically two sentences, but search engines truncate meta descriptions at around 155-160 characters, so almost the entire second sentence — the whole use-case list, which is the point of the rewrite — would be cut off in results. Tightening as suggested above gets the use cases into the visible range.

Minor notes

  • "sequential, in-session user behavior" — "sequential" adds little here and reads as jargon; "in-session" already conveys it. Dropping it also removes the repetition of "user behavior" within one sentence.
  • "product experimentation and A/B testing" — A/B testing is a subset of product experimentation, and pairing them with "and" inside an Oxford-comma list makes the list harder to parse. Consider just "product experimentation".
  • "ML and AI applications" — acronym casing is correct per the style guide ("General technical terms"), but for an SEO description consider "machine learning and AI", since ML is not used anywhere else on the page.

Everything else checks out: US spelling, Oxford comma in the final list item, straight quotes, present tense, second person, and "Signals" capitalized per CLAUDE.md terminology.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
documentation ba9c895 Commit Preview URL

Branch Preview URL
Aug 04 2026, 01:40 PM

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants