Docs set 1 #261

alexander-yevsyukov · 2026-01-20T19:57:17Z

No description provided.

Copilot

Pull request overview

This PR updates project documentation by replacing informal "Please note" phrases with more concise "Note that" phrasing, and bumps version numbers across multiple configuration files and documentation.

Changes:

Simplified documentation language by removing "Please" prefix from note statements
Updated version from 2.0.0-SNAPSHOT.393 to 2.0.0-SNAPSHOT.394 across configuration files
Updated dependency versions (CoreJvmCompiler from .050 to .051, validation-jvm-runtime from .392 to .393)

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
version.gradle.kts	Bumped validation version to .394
tests/consumer/src/test/kotlin/io/spine/validation/test/CurrencyOptionITest.kt	Removed "Please" from documentation note
pom.xml	Updated project version to .394 and dependency versions
jvm-runtime/src/main/kotlin/io/spine/validation/MessageValidator.kt	Simplified "Please note" to "Note" in KDoc
java/src/main/kotlin/io/spine/tools/validation/java/setonce/SetOnceEnumField.kt	Condensed and simplified documentation note
java/src/main/kotlin/io/spine/tools/validation/java/setonce/SetOnceBytesField.kt	Condensed and simplified documentation note
java/src/main/kotlin/io/spine/tools/validation/java/JavaValidationPlugin.kt	Reformatted multi-line KDoc note for clarity
docs/01-getting-started/index.md	Improved line wrapping for better readability
dependencies.md	Updated version references and generation timestamps
config	Updated subproject commit reference
buildSrc/src/main/kotlin/io/spine/dependency/local/Validation.kt	Updated validation version constant to .393
buildSrc/src/main/kotlin/io/spine/dependency/local/CoreJvmCompiler.kt	Updated CoreJvmCompiler versions to .051

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Also: * Update the reference to Jakarta Validation, addressing the recent name change.

Also: * Update Kotlin requirement to 2.2.21+.

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (2)

docs/options.proto:1

Corrected spelling of 'please' to 'use' for consistency with the PR's goal of removing informal language like 'Please' from comments.

/*

docs/ToC.md:1

These link text entries still use title case capitalization ("First Validated Model", "Validation Workflow") while other entries in the same file have been updated to sentence case. These should be changed to "Your first validated model" and "Validation workflow" for consistency.

# Spine Validation — Table of contents

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-22T20:43:29Z

docs/content/00-intro/index.md


-## What’s Next
+## What's next

 - [Target Audience](target-audience.md)


The link text "Target Audience" uses title case, but the PR has changed the target file's heading to sentence case "Target audience". The link text should match for consistency.

Suggested change

- [Target Audience](target-audience.md)

- [Target audience](target-audience.md)

They will be described separately and later. Probably, it's going to be a part of the documentation of the Spine Time library.

Copilot

Pull request overview

Copilot reviewed 32 out of 32 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-23T19:14:30Z

docs/_code/first-model/src/test/kotlin/io/spine/validation/docs/firstmodel/BankCardKtTest.kt

+import org.junit.jupiter.api.assertThrows
+import org.junit.jupiter.api.Assertions.assertDoesNotThrow
+
+@DisplayName("`BankCard`in Kotlin should")


Missing space between backtick and "in". Should be "BankCard in Kotlin should".

Suggested change

@DisplayName("`BankCard`in Kotlin should")

@DisplayName("`BankCard` in Kotlin should")

Copilot · 2026-01-23T19:14:30Z

docs/_code/first-model/src/main/proto/spine/validation/docs/first_model/bank_card.proto

+    // Must be present and contain at least 4 Latin letters or spaces.
+    string owner = 2 [
+        (required) = true,
+        (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$"


The regex pattern differs from the one shown in the documentation file docs/01-getting-started/first-model.md (line 38), which has [a-z] at the end instead of [A-Za-z]. The patterns should match between the actual proto file and the documentation example.

Suggested change

(pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$"

(pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[a-z])$"

Copilot · 2026-01-23T19:14:31Z

docs/content/01-getting-started/first-model.md

+    // Must be present and contain at least 4 Latin letters or spaces.
+    string owner = 2 [
+        (required) = true,
+        (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[a-z])$"


The regex pattern in this documentation differs from the actual pattern in the proto file docs/code/first-model/src/main/proto/spine/validation/docs/first_model/bank_card.proto (line 26), which has [A-Za-z] at the end instead of [a-z]. The patterns should match between the documentation and the actual proto file.

Suggested change

(pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[a-z])$"

(pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$"

... so that we don't have to use the version in the `docs/code` modules explicitly.

Copilot

Pull request overview

Copilot reviewed 36 out of 38 changed files in this pull request and generated no new comments.

Files not reviewed (1)

.idea/inspectionProfiles/Project_Default.xml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 38 out of 42 changed files in this pull request and generated 3 comments.

Files not reviewed (1)

.idea/inspectionProfiles/Project_Default.xml: Language not supported

Comments suppressed due to low confidence (4)

docs/_code/first-model/gradlew.bat:1

This file contains an absolute path to a user's local directory. Gradle wrapper files should not contain absolute paths to specific user directories as this exposes internal file system structure and won't work for other developers. This should be a symbolic link or relative reference.
docs/_code/first-model/gradlew:1
This file contains an absolute path to a user's local directory. Gradle wrapper files should not contain absolute paths to specific user directories as this exposes internal file system structure and won't work for other developers. This should be a symbolic link or relative reference.
docs/_code/first-model/gradle.properties:1
This file contains an absolute path to a user's local directory, which exposes internal file system structure and won't work for other developers. This should be a symbolic link or relative reference.
docs/_code/first-model/buildSrc:1
This file contains an absolute path to a user's local directory, which exposes internal file system structure and won't work for other developers. This should be a symbolic link or relative reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-31T20:23:00Z

docs/_code/first-model/src/main/proto/spine/validation/docs/first_model/bank_card.proto

+    // Must be present and contain at least 4 Latin letters or spaces.
+    string owner = 2 [
+        (required) = true,
+        (pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$"


The regex pattern requires at least 4 characters (one uppercase, at least 2 middle characters, and one letter at the end), but the comment on line 23 states 'at least 4 Latin letters or spaces'. This pattern would accept a 3-character string like 'Abc' if the middle part is exactly 2 characters. The regex should be ^[A-Z](?:[A-Za-z ]{3,})$ to truly require at least 4 characters total.

Suggested change

(pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$"

(pattern).regex = "^[A-Z](?:[A-Za-z ]{3,})$"

Copilot · 2026-01-31T20:23:00Z

docs/content/01-getting-started/first-model.md

+// The digits of the card are simplified for the sake of the example.
+//
+message BankCard {
+    // Must be present and match a simple card pattern.


The regex pattern comment on line 29 says 'Must be present and match a simple card pattern', but doesn't explain what the pattern means. Consider adding a comment explaining that this validates a 16-digit card number formatted as four groups of four digits separated by spaces (e.g., '1234 5678 1234 5678').

Suggested change

// Must be present and match a simple card pattern.

// Must be present and match a 16-digit card number formatted as four

// groups of four digits separated by spaces (for example, "1234 5678 1234 5678").

Copilot · 2026-01-31T20:23:00Z

docs/_options/time_options.proto

+    // Defines a restriction for the timestamp.
+    Time in = 1;
+
+    // Deprecated: please use `error_msg` instead.


Corrected capitalization of 'please' to 'Please' at the start of the sentence.

Suggested change

// Deprecated: please use `error_msg` instead.

// Deprecated: Please use `error_msg` instead.

alexander-yevsyukov added 5 commits January 20, 2026 19:52

Reduce using "please" in docs

d1a3200

Improve text layout

11c6121

Bump version -> 2.0.0-SNAPSHOT.394

b16788a

Bump Validation and CoreJvm Compiler

9c0a34b

Update dependency reports

6379b9f

Copilot AI review requested due to automatic review settings January 20, 2026 19:57

alexander-yevsyukov self-assigned this Jan 20, 2026

alexander-yevsyukov added 2 commits January 20, 2026 19:57

Merge remote-tracking branch 'origin/master' into docs-set-1

1d17e3b

Update config ref.

1397636

Copilot AI reviewed Jan 20, 2026

View reviewed changes

alexander-yevsyukov added 17 commits January 21, 2026 18:28

Remove "Migration Guide" section

6e2fe2b

Improve text layout

479c28c

Remove unnecessary decorations

4230509

Remove hallucinated section links

77bbd9c

Remove redundant horizontal lines

4bf36f0

Convert titles to sentence case

09a9d47

Allow empty lines after headers

90bc7db

Fix the proto options example

78da3fb

Also: * Update the reference to Jakarta Validation, addressing the recent name change.

Use braces around proto options

2d1f0aa

Temporarily add source code of proto options

0300e79

Fix capitalization

94f69c0

Also: * Update Kotlin requirement to 2.2.21+.

Backtick code in ToC

449a789

Put the "Collection constraints" section after "Temporal constraints"

3671ae4

Describe Validation components

16a2736

Remove "Configuration & tooling" section

7fb87ac

Rename "Installation" to "Adding Validation to your build"

51c5036

Describe adding Validation to a Gradle build

d3d0b60

Copilot AI review requested due to automatic review settings January 22, 2026 20:42

Copilot AI reviewed Jan 22, 2026

View reviewed changes

Improve the example type name in the ValidationError docs

5383ae2

alexander-yevsyukov added 11 commits January 22, 2026 21:21

Remove the leading zero in the Introduction section title

0bb6196

Add wording for the first-model.md

f99685a

Remove mentioning of temporal constraints

9f5204a

They will be described separately and later. Probably, it's going to be a part of the documentation of the Spine Time library.

Add code/first-model subproject

e409aa5

Make JVM runtime expose Base.lib at the api level

c681d66

Remove redundant dependencies

9e97727

Remove commented out code

5918462

Improve package name for the BankCard example

fe8e722

Fix Kotlin package path

fe75e36

Add Java test for BankCard

5316c03

Improve Kotlin test name

8ee49bd

Copilot AI review requested due to automatic review settings January 23, 2026 19:04

Copilot AI reviewed Jan 23, 2026

View reviewed changes

alexander-yevsyukov added 7 commits January 23, 2026 19:29

Bump Gradle -> 9.3.0

652a545

Update dependency reports

c1dde85

Add spine-compiler plugin dependency

de11e7e

... so that we don't have to use the version in the `docs/code` modules explicitly.

Remove outdated configuration proto code

e48782a

Update dependency reports

5cc8b40

Add requirements for supported browsers

01e5e12

Auto-updated by IDEA

7300c06

Copilot AI review requested due to automatic review settings January 29, 2026 20:11

Copilot AI reviewed Jan 29, 2026

View reviewed changes

Improve the structure of the docs directory

a274f85

alexander-yevsyukov mentioned this pull request Jan 31, 2026

Consolidate the docs directory SpineEventEngine/documentation#63

Open

5 tasks

Add structure proposal

b7f6ab0

Copilot AI review requested due to automatic review settings January 31, 2026 20:13

Improve formatting

ebe0672

Copilot AI reviewed Jan 31, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs set 1 #261

Docs set 1 #261

Uh oh!

alexander-yevsyukov commented Jan 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 22, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI Jan 23, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 31, 2026

Uh oh!

Copilot AI Jan 31, 2026

Uh oh!

Copilot AI Jan 31, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	- [Target Audience](target-audience.md)
	- [Target audience](target-audience.md)

	@DisplayName("`BankCard`in Kotlin should")
	@DisplayName("`BankCard` in Kotlin should")

	(pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$"
	(pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[a-z])$"

	(pattern).regex = "^[A-Z](?:[A-Za-z ]{2,}[A-Za-z])$"
	(pattern).regex = "^[A-Z](?:[A-Za-z ]{3,})$"

	// Must be present and match a simple card pattern.
	// Must be present and match a 16-digit card number formatted as four
	// groups of four digits separated by spaces (for example, "1234 5678 1234 5678").

	// Deprecated: please use `error_msg` instead.
	// Deprecated: Please use `error_msg` instead.

Docs set 1 #261

Are you sure you want to change the base?

Docs set 1 #261

Uh oh!

Conversation

alexander-yevsyukov commented Jan 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 31, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants