Skip to content

Move documentation conventions to DEVELOPMENT.md - #49

Merged
morisil merged 1 commit into
mainfrom
move-documentation-conventions-to-development
Sep 15, 2026
Merged

morisil merged 1 commit into
mainfrom
move-documentation-conventions-to-development

Conversation

@morisil

@morisil morisil commented Sep 15, 2026

Copy link
Copy Markdown
Member

Moves the ## Documentation conventions section — the semantic line breaks rationale and the ### Markdown soft wrapping in the IDE setup — from README.md to DEVELOPMENT.md.

Both parts address someone about to edit files in this repository, not someone evaluating the project or consuming the published artifact, so they sit better next to the other maintenance notes.

  • README.md — section removed; the ## Development pointer now covers the conventions as well.
  • DEVELOPMENT.md — section appended verbatim, heading levels unchanged; the intro is reframed, as "maintenance notes … update the build tooling and dependencies" no longer described the whole file.
  • CLAUDE.md — the soft-wrapping anchor retargeted from README.md to DEVELOPMENT.md.

No prose was rewritten in the moved section.

🤖 Generated with Claude Code

The semantic line breaks rationale and the IDE soft-wrap setup
both address someone about to edit files in this repository,
not someone evaluating or consuming the published artifact,
so they belong next to the other maintenance notes.

The README keeps a single pointer to DEVELOPMENT.md,
and the CLAUDE.md anchor is retargeted accordingly.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@claude

claude Bot commented Sep 15, 2026

Copy link
Copy Markdown

Review

Clean, well-scoped documentation move — content is preserved verbatim, and the CLAUDE.md anchor is correctly retargeted to DEVELOPMENT.md#markdown-soft-wrapping-in-the-ide. I checked the repo for any other references to the old README.md#markdown-soft-wrapping-in-the-ide / README.md#documentation-conventions anchors and found none outside this diff, so no dangling links remain.

Since this is a pure Markdown reorg (no code, no tests, no security-sensitive surface), the usual code-review categories mostly don't apply here. A couple of minor, non-blocking observations:

  • DEVELOPMENT.md still ends without a trailing newline (pre-existing from before this PR, just now inherited by the appended section) — not introduced by this change, so not worth fixing here unless you're touching the file anyway.
  • The reframed intro line in DEVELOPMENT.md ("Notes for working on this project itself: the conventions its documentation follows, and the tooling and dependency updates worth doing from time to time.") reads well and correctly reflects that the file now covers more than just tooling/dependency maintenance.

No functional or structural issues found. LGTM.

@morisil
morisil merged commit c1ef90e into main Sep 15, 2026
2 checks passed
@morisil
morisil deleted the move-documentation-conventions-to-development branch September 15, 2026 21: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.

1 participant