From fc6edb7d38a276c16a440d76bc5634b0abf22939 Mon Sep 17 00:00:00 2001 From: Asterios Raptis Date: Wed, 22 Jul 2026 13:53:42 +0200 Subject: [PATCH] docs(style): rule 1 covers all self-authored docs prose, not only the blog (refs #80) The 68 faked dashes in docs/*.md (#80) raised the scope question: STYLE.md's own wording limited every rule to docs/blog/. Decision: rule 1 (no em-dashes, no faked spaced-hyphen pauses) extends to every self-authored Markdown file under docs/, because the reference docs are the same editorial prose with the same single author as the blog. The other rules stay blog-specific, and learner content in the content repositories stays out of scope (foreign, multilingual authorship). The 68 existing findings are NOT fixed here: replacing each dash is per-sentence editing (comma, colon, parentheses, sentence break) and happens as its own sweep under #80, which stays open until then. Co-Authored-By: Claude Fable 5 --- docs/blog/STYLE.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/blog/STYLE.md b/docs/blog/STYLE.md index 6cf5d5e..27502d6 100644 --- a/docs/blog/STYLE.md +++ b/docs/blog/STYLE.md @@ -4,6 +4,13 @@ Formatting rules for every article under `docs/blog/`. They apply from the first draft on, not as an afterthought. (They extend the repository-wide no-em-dash rule from the coding standards to prose.) +Rule 1 applies beyond the blog: every self-authored Markdown file under +`docs/` is the same kind of editorial prose and follows it (decided in #80; +the reference docs are brought up to the rule in a separate sweep). The +other rules stay blog-specific. Learner content in the content repositories +is out of scope: that is multilingual material with its own authorship and +its own conventions. + This is the single place the blog formatting guidelines live (elsewhere referred to as the "formatierungsrichtlinien-blog-engine-cc" rules). Read it before drafting or reviewing an article. @@ -72,3 +79,9 @@ grep -oP '[^\x00-\x7F]' docs/blog/
.md | sort -u # review every non-AS The second grep matters: a spaced hyphen used as a pause is rule 1's other half and a plain U+2014 count misses it entirely. Ignore hits inside code fences (ASCII diagrams) and table rows. + +Because rule 1 covers all of `docs/`, its check also runs corpus-wide: + +```shell +grep -rnP '\S - \S' docs --include='*.md' # faked em-dashes anywhere under docs/ +```