From 7fc6c627dc1587a41b96c6c695ad624d27ec8ea2 Mon Sep 17 00:00:00 2001 From: alexander-yevsyukov Date: Fri, 24 Jul 2026 19:47:20 +0100 Subject: [PATCH] Fix factual and code errors surfaced by a full-repo proofread 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 --- EMBEDDING.md | 2 +- .../samples/src/main/proto/spine/site/home/events.proto | 7 ++++--- docs/content/docs/guides/gradle.md | 2 +- docs/content/docs/introduction/naming-conventions.md | 6 +++--- docs/content/docs/resources/people.md | 2 +- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/EMBEDDING.md b/EMBEDDING.md index 9e766de..1c3c35c 100644 --- a/EMBEDDING.md +++ b/EMBEDDING.md @@ -115,7 +115,7 @@ to the documentation files using the tool. The most important points here are: If you encounter an error indicating that the executable file cannot be run, it likely does not have execution permissions. To grant execution rights -on Linux or macOS, run the following command from the `_code` directory: +on Linux or macOS, run the following command from the `docs/_bin` directory: ```shell chmod +x embed-code-macos diff --git a/docs/_code/samples/src/main/proto/spine/site/home/events.proto b/docs/_code/samples/src/main/proto/spine/site/home/events.proto index 379e1c7..b7d5b2f 100644 --- a/docs/_code/samples/src/main/proto/spine/site/home/events.proto +++ b/docs/_code/samples/src/main/proto/spine/site/home/events.proto @@ -1,11 +1,11 @@ /* - * Copyright 2020, TeamDev. All rights reserved. + * Copyright 2026, TeamDev. All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * * Redistribution and use in source and/or binary forms, with or without * modification, must retain the above copyright notice and the following @@ -23,6 +23,7 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ + syntax = "proto3"; package spine.site.home; @@ -31,7 +32,7 @@ import "spine/options.proto"; option (type_url_prefix) = "type.spine.io"; option java_package = "io.spine.site.home.event"; -option java_outer_classname = "CommandsProto"; +option java_outer_classname = "EventsProto"; option java_multiple_files = true; import "spine/site/home/identifiers.proto"; diff --git a/docs/content/docs/guides/gradle.md b/docs/content/docs/guides/gradle.md index a15e3e4..3c4ebdc 100755 --- a/docs/content/docs/guides/gradle.md +++ b/docs/content/docs/guides/gradle.md @@ -129,7 +129,7 @@ domain language with another, add a dependency between them. This way, the downs use Protobuf definitions of the upstream context. ```groovy dependencies { - implemetation(project(':model-users')) + implementation(project(':users-model')) } ``` diff --git a/docs/content/docs/introduction/naming-conventions.md b/docs/content/docs/introduction/naming-conventions.md index 82fdc7c..9087075 100755 --- a/docs/content/docs/introduction/naming-conventions.md +++ b/docs/content/docs/introduction/naming-conventions.md @@ -144,7 +144,7 @@ message TaskCreated { lang="proto" >}} message TaskProjection { TaskId task = 1; - ProjectId project = 2 + ProjectId project = 2; string name = 3; } {{< /code-with-label >}} @@ -320,7 +320,7 @@ a command message. #### Events -Similarly to commands, we recommend putting events generated by an entity under the `entity` +Similarly to commands, we recommend putting events generated by an entity under the `event` sub-package: * `io.acme.todolist.task.event` @@ -412,7 +412,7 @@ of a programming language. #### Factory classes A Java class that creates and configures an instance of a `BoundedContext` is named after the -name of the context with the `Context` prefix: +name of the context with the `Context` suffix: * `UsersContext` * `DeliveredOrdersContext` diff --git a/docs/content/docs/resources/people.md b/docs/content/docs/resources/people.md index e8f18b4..fc20705 100644 --- a/docs/content/docs/resources/people.md +++ b/docs/content/docs/resources/people.md @@ -18,7 +18,7 @@ The creators and drivers of the DDD ideas. {"url":"https://x.com/ericevans0", "icon":"fab fa-twitter"} ]`>}} The author of the DDD methodology. Domain linguist. The author -of “Domain-Driven Design: Tackling Complexity in Software”. +of “Domain-Driven Design: Tackling Complexity in the Heart of Software”. {{< /person-card >}} {{< person-card