Skip to content

prose: the whole site to the house writing style - #116

Merged
ronaldtse merged 18 commits into
mainfrom
prose-docs-guides
Sep 18, 2026
Merged

ronaldtse merged 18 commits into
mainfrom
prose-docs-guides

Conversation

@ronaldtse

Copy link
Copy Markdown
Contributor

What

The site's entire published prose is rewritten to the house writing style (branding/WRITING-STYLE.md, adopted from oimlsmart/branding — the announcement register for posts, the technical register for documentation and pages). 75 files:

  • _docs/guides (14) + _docs/reference (10)
  • _docs/architecture (25)
  • _posts/2026-* (23 — the posts since 2026; pre-2026 posts untouched)
  • src/pages (index, about, 404)

What changed

Fragments, headline clips, teaser lines, second-person descriptive prose, contractions, marketing asides and coined-label leads became complete declarative sentences with stated agents; announcements moved to the present perfect and explanations to the present tense; terms are expanded at first use; boundaries are stated as sentences. Headline labels, section headings, anchors and all structure are preserved.

What did NOT change

Every ---- code block, ++++ passthrough (SVG figures), // comment, command, output, path, version, benchmark number, link, xref and anchor is byte-identical to main — verified per-file by fence-region extractors in each pass, plus the site's own prose-lint.test.ts and frontmatter zod schemas. npm run build exits 0 (the full page set builds).

Content bugs found and deliberately NOT fixed here (style-only PR — each needs a facts decision)

  1. shims.adoc says there is no tebako doctor; debug.adoc + cli-tebako.adoc document it as shipped in v2.8.0 — one page is stale.
  2. library.adoc cites a tebako shim use verb that no reference lists.
  3. repositories.adoc (detached signatures live since v2.6.0) contradicts chain-of-trust.adoc (detached .asc signatures listed as planned).
  4. about.astro still describes the Ruby runtime as "patched and embedded" — the v1 model; the v2 architecture is a downloaded, shared, mounted runtime.
  5. migrate-v1-v2.adoc says prebuilt binaries are "still in final validation", predating the first tagged releases.
  6. The two JIT posts cite PEP 836 for CPython's JIT where the neighboring post (and the actual PEP) is 744.

…tch, driver-contract, encryption to the house style
…ion, jails-and-proxying, migrate-v1-v2 to the house style
…, runtime-as-image, store, vfs to the house style
@ronaldtse
ronaldtse merged commit f1a58f3 into main Sep 18, 2026
7 checks passed
@ronaldtse
ronaldtse deleted the prose-docs-guides branch September 18, 2026 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant