Skip to content

docs(style): rule 1 covers all self-authored docs prose (refs #80)#82

Merged
astrapi69 merged 1 commit into
mainfrom
docs/style-rule1-docs-wide
Jul 22, 2026
Merged

docs(style): rule 1 covers all self-authored docs prose (refs #80)#82
astrapi69 merged 1 commit into
mainfrom
docs/style-rule1-docs-wide

Conversation

@astrapi69

Copy link
Copy Markdown
Owner

Editorial decision from #80, part 1 of 2: the scope.

Decision: STYLE.md rule 1 (no em-dashes, no faked spaced-hyphen pauses) extends from docs/blog/ to every self-authored Markdown file under docs/. Rationale: the reference docs (lesson-format.md, extensions.md, architecture.md, validation.md, ...) are the same kind of editorial prose with the same single author as the blog articles the rule was written for. That is exactly the line that separates them from learner content in the content repositories, which stays out of scope: foreign, multilingual material with its own authorship.

Changes:

  • Scope paragraph in the STYLE.md intro naming what rule 1 now covers, what stays blog-specific, and what stays out of scope.
  • Corpus-wide variant of the rule-1 check added to the Checking section.

Deliberately not in this PR: the 68 existing findings across 8 files. Each replacement is a per-sentence editorial choice (comma, colon, parentheses, or sentence break), so the sweep is its own follow-up under #80. #80 stays open until that sweep lands.

Full suite green: 503 tests, 29 files.

🤖 Generated with Claude Code

… 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 <noreply@anthropic.com>
@astrapi69
astrapi69 merged commit 4276f55 into main Jul 22, 2026
4 checks passed
@astrapi69
astrapi69 deleted the docs/style-rule1-docs-wide branch July 22, 2026 11:54
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