Skip to content

Fix factual and code errors surfaced by a full-repo proofread#86

Open
alexander-yevsyukov wants to merge 1 commit into
masterfrom
claude/zen-cartwright-f94817
Open

Fix factual and code errors surfaced by a full-repo proofread#86
alexander-yevsyukov wants to merge 1 commit into
masterfrom
claude/zen-cartwright-f94817

Conversation

@alexander-yevsyukov

Copy link
Copy Markdown
Contributor

What

Seven factual/code corrections to the documentation, surfaced by a full-repo prose proofread but out of that proofread's (prose-only) scope. Each is a one-line fix, spread across five files.

File Fix
docs/_code/samples/…/spine/site/home/events.proto java_outer_classname "CommandsProto""EventsProto" — a copy-paste slip from commands.proto that compiled only because java_package differs
docs/content/docs/guides/gradle.md implemetationimplementation, and :model-users:users-model to match the surrounding users-model/trains-model/billing-model prose convention
docs/content/docs/introduction/naming-conventions.md events sub-package entityevent; BoundedContext factory-class Context "prefix" → "suffix"; missing ; after ProjectId project = 2 in the TaskProjection snippet
EMBEDDING.md chmod-instruction directory _codedocs/_bin, where the executable is actually placed
docs/content/docs/resources/people.md Domain-Driven Design subtitle → "Tackling Complexity in the Heart of Software" (matches books.md)

Why

Each is an inaccuracy a reader would trip on: a mislabeled generated Java class, an uncompilable Gradle snippet (typo) with an inverted module name, two wrong words in the naming guide, a proto snippet missing a statement terminator, a troubleshooting step pointing at the wrong directory, and a misquoted book title.

Verification

  • Proto change compiled independently. All three sample protos (identifiers / commands / events) were run through a standalone protoc; it generates event/EventsProto.java alongside command/CommandsProto.java with no outer-class name collision.
  • review-docs reviewed the diff against Spine documentation conventions → APPROVE, no Must-fix / Should-fix.
  • No links were added or modified, so check-links is not needed for this change.
  • git grep confirms no other occurrence of any of these mistakes remains.

The repo's own ./gradlew :buildAll / checkSamples were not run here for pre-existing, unrelated reasons: the docs/_code/samples build is broken on Apple Silicon (protoc 3.13.0 has no osx-aarch_64 binary; dead JCenter), and checkSamples is currently vacuous (its config points at a docs/content/docs/1 path that no longer exists, and the tool's arg error does not fail the task). Both are being addressed on separate branches.

Notes for the reviewer

  • The events.proto diff also carries a copyright-header refresh (year 20202026, license URL → https) applied automatically by the repo's update-copyright hook when the file was edited.
  • gradlew.bat on this branch shows unrelated, pre-existing line-ending churn; it is intentionally excluded from this commit.

🤖 Generated with Claude Code

A prose-only proofread of the docs flagged seven bugs that were out of
its scope. Each is a one-line correction:

- events.proto: java_outer_classname was "CommandsProto" (a copy-paste
  slip from commands.proto that compiled only because java_package
  differs); corrected to "EventsProto".
- gradle.md: fix the "implemetation" typo and align the snippet's
  module name with the surrounding prose (:users-model).
- naming-conventions.md: events belong under the `event` sub-package
  (not "entity"); a BoundedContext factory class uses the `Context`
  suffix (not "prefix"); add the missing semicolon after
  `ProjectId project = 2` in the TaskProjection snippet.
- EMBEDDING.md: the chmod instruction now points at docs/_bin, where
  the executable is placed, instead of _code.
- people.md: correct the Domain-Driven Design subtitle to "Tackling
  Complexity in the Heart of Software" (matches books.md).

The events.proto copyright header was refreshed by the repo's
update-copyright hook (year and license URL).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@alexander-yevsyukov alexander-yevsyukov self-assigned this Jul 24, 2026
@alexander-yevsyukov alexander-yevsyukov moved this to 🏗 In progress in v2.0 Jul 24, 2026
@alexander-yevsyukov alexander-yevsyukov moved this from 🏗 In progress to In Review in v2.0 Jul 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Review

Development

Successfully merging this pull request may close these issues.

1 participant