Fix factual and code errors surfaced by a full-repo proofread#86
Merged
Conversation
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>
armiol
approved these changes
Jul 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
docs/_code/samples/…/spine/site/home/events.protojava_outer_classname"CommandsProto"→"EventsProto"— a copy-paste slip fromcommands.protothat compiled only becausejava_packagediffersdocs/content/docs/guides/gradle.mdimplemetation→implementation, and:model-users→:users-modelto match the surroundingusers-model/trains-model/billing-modelprose conventiondocs/content/docs/introduction/naming-conventions.mdentity→event; BoundedContext factory-classContext"prefix" → "suffix"; missing;afterProjectId project = 2in theTaskProjectionsnippetEMBEDDING.md_code→docs/_bin, where the executable is actually placeddocs/content/docs/resources/people.mdbooks.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
identifiers/commands/events) were run through a standaloneprotoc; it generatesevent/EventsProto.javaalongsidecommand/CommandsProto.javawith no outer-class name collision.review-docsreviewed the diff against Spine documentation conventions → APPROVE, no Must-fix / Should-fix.check-linksis not needed for this change.git grepconfirms no other occurrence of any of these mistakes remains.The repo's own
./gradlew :buildAll/checkSampleswere not run here for pre-existing, unrelated reasons: thedocs/_code/samplesbuild is broken on Apple Silicon (protoc 3.13.0 has noosx-aarch_64binary; dead JCenter), andcheckSamplesis currently vacuous (its config points at adocs/content/docs/1path 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
events.protodiff also carries a copyright-header refresh (year2020→2026, license URL →https) applied automatically by the repo'supdate-copyrighthook when the file was edited.gradlew.baton this branch shows unrelated, pre-existing line-ending churn; it is intentionally excluded from this commit.🤖 Generated with Claude Code