Skip to content

docs(blog): style audit, two new rules, and the German translation of article 3#74

Merged
astrapi69 merged 2 commits into
mainfrom
docs/blog-style-conformance
Jul 22, 2026
Merged

docs(blog): style audit, two new rules, and the German translation of article 3#74
astrapi69 merged 2 commits into
mainfrom
docs/blog-style-conformance

Conversation

@astrapi69

Copy link
Copy Markdown
Owner

Audits the three-part blog series against the seven formatting rules and completes the style guide.

Method

Read each article in full, not just grep for em-dashes. Some rules (disguised tables, decorative rhetorical questions) are invisible to text search.

Findings

The prose was almost entirely clean already:

Rule Result across all three articles
No em-dashes 0
Real UTF-8, real umlauts clean (German examples use ä/ö/ü/ß; no ae/oe/ue/ss)
No hidden control / zero-width chars 0
No emojis 0
Real Markdown tables all tabular data already in real tables; the bullet lists are genuine prose lists
Closing summary all three already close with one

One substantive fix:

  • Decorative rhetorical question in the lesson creator walkthrough. "Don't like the mix? Regenerate..." became "To change the mix, Regenerate...". Every other question mark in the series carries the argument (the schema-first thesis question, the transition into the extension tier, the core-or-extension decision test) or sits inside a quoted example, so those stay.

Style guide

STYLE.md gained the two rules it was missing, so the guidelines are complete in one place:

  • Rhetorical questions (rule 4): allowed only when they frame the problem, bridge a section, or pose a test the reader answers; not as filler.
  • Closing summaries (rule 6): a default where an article argues or walks a process.
  • The tables rule now also states the converse: a bullet list of prose explanations is a list, not a table to force into columns.

Renumbered to stay contiguous. The header now names the formatierungsrichtlinien-blog-engine-cc alias the task referred to, so a search for that name lands on this file (it does not exist under that name; STYLE.md is the guide).

Note

The two em-dash matches remaining in STYLE.md are the rule text itself (naming the forbidden and the grep command that checks for it), not violations.

make release-check green.

🤖 Generated with Claude Code

astrapisixtynine and others added 2 commits July 22, 2026 09:06
Read all three articles in full against the seven formatting rules, not
just grep for em-dashes. Result: the prose was almost entirely clean
already (0 em-dashes, real UTF-8, no hidden characters, no emojis, real
Markdown tables throughout, every article closes with a summary).

One substantive fix: a decorative rhetorical question in the lesson
creator walkthrough ("Don't like the mix? Regenerate...") became the
statement it should have been ("To change the mix, Regenerate..."). Every
other question mark in the series carries the argument (the schema-first
thesis question, the core-or-extension decision test) or sits inside a
quoted example, and stays.

STYLE.md gained the two rules it was missing so the guide is complete in
one place: rhetorical questions (allowed only when they do real work) and
closing summaries (a default where an article argues or walks a process).
The tables rule also now says the converse: a bullet list of prose
explanations is a list, not a table to be forced into columns. Renumbered
to stay contiguous, and the header now names the
"formatierungsrichtlinien-blog-engine-cc" alias so a search for that name
lands here.

make release-check green.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Adds docs/blog/de/create-a-lesson-in-the-app.md with its own screenshot
set, captured with DOCS_LANG=de against current develop. A language
directory rather than a .de.md sibling: a three-part series will grow
more translations, and directories scale where suffixed siblings do not.

Writing it against real German screenshots exposed four things the
English article was getting wrong, all now fixed in both languages:

1. The review checklist has FIVE items, not six. "Language pair is
   valid" has not been rendered for a while; its i18n key survives in all
   11 catalogs while no component references it. Filed as app#1929.
2. Dictation now has an audio UPLOAD (app#1911, stored inline as a data
   URI) alongside the typed asset path. The article claimed there was no
   upload and listed that as an honest limit. Both statements are gone;
   the real remaining limit is that recording in the browser is not built.
3. The generator's missing-type notice is an instruction, not a label:
   "Picture choice: add an image to at least two cards", not the bare
   "picture_choice" the article quoted.
4. Nine faked em-dashes (a spaced hyphen used as a pause) across two
   English articles, which rule 1 forbids just as much as U+2014. My
   earlier audit grepped only for U+2014 and missed every one of them.
   STYLE.md's Checking section now greps for both, so the guide's own
   audit catches what I did not.

All English screenshots were refreshed from one consistent develop run,
since the article claims every shot comes from a single flow and the app
had moved underneath several of them (upload, richer notices, the
ext_payload edit-mode fix in app#1926).

The German text uses the German UI labels throughout, because the German
screenshots do: the extension picker shows "Kategorisierung", "Diktat"
and so on rather than the technical ids the English UI displays, so that
paragraph and its table were rewritten rather than translated.

make release-check green. STYLE.md holds for all four articles: no
em-dashes real or faked, real umlauts, no hidden characters, no emojis,
real Markdown tables, closing summaries.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@astrapi69 astrapi69 changed the title docs(blog): audit the series against the style guide; add two rules docs(blog): style audit, two new rules, and the German translation of article 3 Jul 22, 2026
@astrapi69

Copy link
Copy Markdown
Owner Author

Scope grew after the first commit. The German translation of article 3 landed on this branch, and writing it exposed several factual errors in the English article. Summary of the full branch:

Style audit

Rule Result
No em-dashes (U+2014) 0 across all articles
No faked em-dashes (spaced hyphen as a pause) 9 found and fixed
Real UTF-8, real umlauts clean
No hidden control / zero-width chars 0
No emojis 0
Real Markdown tables already correct
Rhetorical questions one decorative one removed; the rest carry the argument
Closing summary already present in all

The faked em-dashes are the notable miss: rule 1 forbids them as much as U+2014, and my first pass grepped only for the literal character. STYLE.md's Checking section now greps for both, so the guide's own audit catches what I did not.

German translation

docs/blog/de/create-a-lesson-in-the-app.md with its own screenshot set (DOCS_LANG=de against current develop). A language directory rather than a .de.md sibling. The German text uses German UI labels throughout, because the German screenshots do: the extension picker shows "Kategorisierung", "Diktat" and so on, not the technical ids the English UI displays, so that paragraph and its table were rewritten rather than translated.

Corrections the translation exposed

  1. The review checklist has five items, not six. "Language pair is valid" has not been rendered for some time; its i18n key survives in all 11 catalogs with nothing referencing it. Filed as adaptive-learner#1929.
  2. Dictation has an audio upload now (adaptive-learner#1911, inline data URI) alongside the typed asset path. The article claimed there was none and listed it as an honest limit. Both corrected; the real remaining limit is that browser recording is not built.
  3. The missing-type notice is an instruction, not a label: "Picture choice: add an image to at least two cards", not the bare picture_choice that was quoted.

All English screenshots were refreshed from one consistent develop run, since the article claims every shot comes from a single flow and the app had moved underneath several of them.

make release-check green; all 22 image references resolve.

@astrapi69
astrapi69 merged commit a3fd1e6 into main Jul 22, 2026
4 checks passed
@astrapi69
astrapi69 deleted the docs/blog-style-conformance branch July 22, 2026 12:00
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.

2 participants