docs: capitalize WebJs at sentence starts in prose#851
Conversation
vivek7405
left a comment
vivek7405
left a comment
There was a problem hiding this comment.
Went through the whole diff for the one thing that can go wrong here: "WebJs" landing somewhere it shouldn't. Found and fixed five spots.
The CLI list was missing generate, so webjs generate ... in an old cli changelog got capitalized. And four line-wrap continuations where a prose line just happens to start with webjs mid-sentence got treated as sentence starts: ...which webjs has... (agent-docs/advanced.md), In webjs SSR (lit-muscle-memory-gotchas.md), for webjs tags (intellisense/README.md), and the whole webjs language service (vscode/AGENTS.md). All reverted to lowercase in 5065c24.
Also pulled changelog/** out entirely: it's generated from commit subjects, so editing it by hand just drifts. Everything else (code spans, fenced blocks, webjs.* keys, @webjsdev, WEBJS_*, wordmarks) was correctly left alone. Rechecked the docs .ts pages for the same line-wrap class, none there since each
is one line.
vivek7405
left a comment
vivek7405
left a comment
There was a problem hiding this comment.
Second pass, clean. Every remaining WebJs is a real sentence start; code, CLI, config keys, env vars, and wordmarks are all still lowercase.
Add a fifth class to block-prose-punctuation.sh that blocks lowercase 'webjs' at a prose sentence start (after .!?, at a line/marker/emphasis start, or after a prose HTML tag), while keeping it lowercase for CLI commands, webjs.dev, @webjsdev, webjs.* config keys, WEBJS_* env vars, inline code, and mid-sentence mentions. Mirrors the em-dash rule. The scaffold template copy is deliberately left unchanged: a generated app is not webjs-branded, so it must not enforce this casing.
vivek7405
force-pushed
the
chore/webjs-capitalization
branch
from
25f12d0 to
57104fd
Compare
1 participant
Closes #852
Capitalize "webjs" to "WebJs" wherever it begins a prose sentence (after a full stop, at a line/paragraph start, after list or blockquote markers, or wrapped in emphasis like
**webjs**), across the marketing website, the docs site, and every tracked markdown file in the repo.The brand token stays lowercase everywhere it is NOT a sentence start:
webjs <subcommand>CLI references,webjs.dev,@webjsdev,webjs.*config keys,WEBJS_*env vars, inline`code`spans, fenced code blocks, and the logo wordmarks. This is a cosmetic prose-consistency pass, no behaviour change.What changed
website/: 3 prose fixes (app/page.ts,lib/samples.ts).docs/site: 110 prose fixes across 40page.tspages.git ls-files '*.md'): applied via a fence-aware script that skips fenced/inline code and every CLI-subcommand reference. IncludesAGENTS.md,agent-docs/*,README.md,blog/,examples/blog/, scaffold templates' per-agent rule files, and package READMEs.packages/ui/packages/website/): N/A, no prose sentence-starts (onlywebjs uiCLI/wordmark).Deliberately excluded
.js/.tscomments,.cursorrules, CLI generator string literals inpackages/cli/lib) unless the user asks to extend.changelog/**excluded entirely: auto-generated from commit subjects, so hand edits would drift.Test plan
code>WebJs,WebJs <subcommand>,WebJs.dev,@WebJs, orWebJsdevcorruption.webjs generate), 4 line-wrap false positives, changelog exclusion.