docs: rewrite docs site and README copy in plainer language - #59
Merged
Conversation
Pass over every user-facing text surface to replace vague marketing phrasing with statements of what the package actually does. The marketplace readme was the worst offender: a bold-label-colon feature list, a puffery line about "where content decisions happen", and a "Ready to bring your analytics into the backoffice?" call to action. It is now six bullets that each name a concrete behaviour. On the landing page, "The traffic signals that matter for the current editorial task, within immediate reach, with nothing more to configure" said nothing specific to this package. Replaced with the actual contents of the dashboard. The phrase "follow a headline number down to the context behind it" appeared in four files and is gone from all of them. The Plausible card claimed you could explore "privacy-friendly traffic", which is not a property traffic can have; it now names what Plausible adds over Vercel. Both provider pages opened with "The quickstart owns the first-time setup flow". Vague capability statements now name the mechanism: "The backoffice adapts to those capabilities" became "The backoffice hides both controls on a Vercel connection". Also thinned out repetition introduced while rewriting: "already" ran six times on the landing page alone, the marketplace bullets all opened with the same verb form, and the "a hidden panel is not an error" fact was stated six times across the doc set. It now stays where it is the point and comes out of the overview's Compatibility section. Two accuracy fixes found along the way: - A marketplace screenshot caption said "provider-supported events and features" where it meant feature flags. - A document-analytics condition read "Its nearest configured document root must specifically resolve to one or more connections, not merely any ancestor root", mixing "must" into a list of plain conditions and repeating a clause from earlier on the page. No behaviour or structural changes. Docs build, type-check, and validate clean; the 9 asset warnings from `blume validate` predate this change.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The marketplace listing is a standalone landing surface, reached without going through the docs site, but it only described what the package does. Someone reading it had no way to get started without first finding the documentation link on the last line. Adds a short Install section (package reference, version and provider prerequisites, the Plausible Cloud Business plan requirement) and a four-step connection setup covering the credential, the restart, the Settings screen, and Test connection. Gives the documentation link its own section rather than a bare trailing sentence. Steps verified against apps/docs/docs/quickstart.mdx and the document analytics guide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pass over every user-facing text surface (docs site, landing page, README, contributing guide, marketplace listing) to replace vague marketing phrasing with statements of what the package actually does.
What changed
The marketplace readme was the worst offender. A bold-label-colon feature list (
**Site-wide analytics:** Follow visitors...), a puffery line about "where content decisions happen", and a "Ready to bring your analytics into the backoffice?" call to action. It is now six bullets that each name a concrete behaviour.The landing page had a section headed "Insight where editors already work" with the subhead "The traffic signals that matter for the current editorial task, within immediate reach, with nothing more to configure." That sentence could appear unchanged in any product's docs. It is now "What's in the dashboard" over a subhead that says what is in it. Same treatment for the feature cards: "the headline numbers, one click away" became the actual list of dimensions, and "follow a headline number down to the context behind it" (which appeared in four separate files) became "Each metric shows how it moved against the period before it."
The Plausible card claimed you could explore "privacy-friendly traffic", which is not a property traffic can have. It now names what Plausible adds over Vercel: global event filtering and custom event properties.
Both provider pages opened with "The quickstart owns the first-time setup flow." Vague capability statements now name the mechanism: "The backoffice adapts to those capabilities" became "The backoffice hides both controls on a Vercel connection."
Throughout: unpicked semicolon splices, cut a colon used as a mid-sentence connector, replaced
1–730with1 to 730, and fixed the one em dash inPRODUCT.md.Second pass
A follow-up audit caught repetition introduced by the rewrite itself:
**Multi-site support.** More than one connection per Umbraco installationis a bold label restating its own line.Accuracy fixes found along the way
document-analyticscondition read "Its nearest configured document root must specifically resolve to one or more connections, not merely any ancestor root", which mixedmustinto a list of plain conditions and repeated a clause from earlier on the page. Now: "Its nearest mapped ancestor resolves to at least one connection. A mapped root further up the tree does not count."CONTRIBUTING.md, the client-build gotcha was folded into a run-on that buried the instruction. Only packing triggers the client build, so during development you run it yourself.Notes for review
apps/docs/pages/index.astrochanges are all string literals and heading text.pnpm docs:checkand an isolatedblume buildboth pass.blume validatereports 9 broken-asset warnings, all of which reproduce onmainunchanged and are unrelated to this PR.apps/docs/umbraco-package.tsandumbraco-marketplace.jsoncarry the package summary and marketplace description, so those were updated to match.PRODUCT.mdis left alone apart from the em dash. Its abstraction ("quietly delightful", "Delight through fluency") is a brand-voice brief rather than user-facing documentation, so rewriting it would change what the file is for. Happy to take it in the same direction if you'd prefer.