generated from SpineEventEngine/template
-
Notifications
You must be signed in to change notification settings - Fork 0
Add text to "Getting started" documentation section #267
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+468
−257
Merged
Changes from all commits
Commits
Show all changes
48 commits
Select commit
Hold shift + click to select a range
a10f379
Bump version -> `2.0.0-SNAPSHOT.397`
alexander-yevsyukov 5b2bf77
Add documentation plan file
alexander-yevsyukov ab82bf8
Remove temporary ToC and update the plan
alexander-yevsyukov 90f21e4
Address the first task from the plan
alexander-yevsyukov c63c041
Add prefix for the developer's guide folder name
alexander-yevsyukov 8dfbe31
Add prefix for the developer's guide folder name
alexander-yevsyukov b0fbaf6
Transform custom validation text into a folder
alexander-yevsyukov 496cbce
Update the link in the plan
alexander-yevsyukov 2369333
Split `first-model.md` into phased pages
alexander-yevsyukov 971b82d
Simplify "Quick path" section
alexander-yevsyukov 64462bd
Get the latest theme updates
JuliaEvseeva b2f1a67
Merge pull request #268 from SpineEventEngine/get-theme-updates
alexander-yevsyukov ed56404
Get the latest theme updates
JuliaEvseeva 87d5926
Merge pull request #269 from SpineEventEngine/get-theme-updates
alexander-yevsyukov 64f4a8e
Add language name for console examples
alexander-yevsyukov f5e386d
Add existing pages for sidebar
alexander-yevsyukov 1ed9283
Bump version -> `2.0.0-SNAPSHOT.398`
alexander-yevsyukov bfb5d42
Update examples ref.
alexander-yevsyukov 9db6b2b
Add front matter to the pages
alexander-yevsyukov 3ba05f9
Update dependency reports
alexander-yevsyukov f909ce7
Use the note block
alexander-yevsyukov 2cd6bdc
Improve the text on standalone Validation plugin setup
alexander-yevsyukov 67eb3f4
Mention Google Truth and Kotest Assertions
alexander-yevsyukov e304c81
Update `_examples` ref.
alexander-yevsyukov 570f65b
Update embedded code
alexander-yevsyukov 6d750bd
Fix the key of the "Getting started" section
alexander-yevsyukov 9233721
Update dependency reports
alexander-yevsyukov 5761811
Narrow down "What you'll learn" section
alexander-yevsyukov d339ca5
Mark "Getting started" completed
alexander-yevsyukov 61d6dd7
Add the note on using `validate()` in the production code
alexander-yevsyukov 8eb959e
Remove duplicating comment
alexander-yevsyukov d71343e
Update `_examples` ref.
alexander-yevsyukov 5fa30ff
Fix the side-navigation `key`
JuliaEvseeva 8d91e0f
Add the link
JuliaEvseeva 85fbe62
Use sentence capitalization in titles in front matter
alexander-yevsyukov 596df41
Improve wording of "Using the generated code" section
alexander-yevsyukov e7c3391
Remove irrelevant doc plan item
alexander-yevsyukov be2b6e9
Mention usage in an anticorruption layer
alexander-yevsyukov 893f6a6
Get theme updates with the fix for relative URLs
JuliaEvseeva 97eee7f
Add empty Concepts section
alexander-yevsyukov 197a4b5
Merge pull request #270 from SpineEventEngine/fix-sidenav
alexander-yevsyukov 6a487d9
Fix placement of pictures by sections
alexander-yevsyukov e7ffef1
Update module list and clarify the purposes
alexander-yevsyukov be4f91a
Make table headers come in bold
alexander-yevsyukov 15f1614
Replace "ProtoData" with "Compiler" on the diagram
alexander-yevsyukov c13a83d
Replace "Policy" with "Reaction" in the docs
alexander-yevsyukov dd9e3bf
Replace "Policy" with "Reaction" in the docs
alexander-yevsyukov f128a97
Improve section description
alexander-yevsyukov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # Spine Validation documentation plan (repo-local) | ||
|
|
||
| This repository contains the **staging** content for Spine Validation docs. | ||
| The goal of this plan is to turn the existing drafts + references into a coherent, | ||
| buildable documentation set, without expanding scope unnecessarily. | ||
|
|
||
| ## Key locations (source of truth) | ||
|
|
||
| - Docs content (Hugo): `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/` | ||
| - Protobuf options reference (for built-ins): | ||
| - `/Users/sanders/Projects/Spine/validation/docs/_options/options.proto` | ||
| - `/Users/sanders/Projects/Spine/validation/docs/_options/time_options.proto` | ||
| - Example projects for embedded snippets: `/Users/sanders/Projects/Spine/validation/docs/_examples/` | ||
| - Docs build notes: `/Users/sanders/Projects/Spine/validation/docs/GRADLE.md` | ||
|
|
||
| ## Definition of done (for a “first complete docs cut”) | ||
|
|
||
| - Navigation is consistent (no dead links between pages). | ||
| - Embedded code snippets are up-to-date (`checkSamples` passes). | ||
| - Preview site builds locally (`buildSite` succeeds). | ||
| - “Getting started” can be followed end-to-end without guessing. | ||
|
|
||
| ## Minimal task list (in order) | ||
|
|
||
| 1) Information architecture (IA): make Hugo navigation coherent | ||
| - Status: DONE (2026-02-23). | ||
| - Added/updated section landing pages: | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/_index.md` | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/09-developers-guide/_index.md` | ||
| - Replaced broken `.../index.md` links with directory links where appropriate: | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/00-intro/_index.md` | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/01-getting-started/_index.md` | ||
| - Added “What’s next” navigation to keep a clear reading path: | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/00-intro/target-audience.md` | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/00-intro/philosophy.md` | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/09-developers-guide/architecture.md` | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/09-developers-guide/key-modules.md` | ||
| - `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/01-getting-started/first-model.md` | ||
| - Fixed an obvious broken image reference: | ||
| `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/08-custom-validation/_index.md` | ||
|
|
||
| 2) Complete “Getting started” flow | ||
| - Status: DONE (2026-02-24). | ||
| - Validate that the "Getting started" section covers: | ||
| importing options, build-time validation, `build()` vs `buildPartial()`, and `validate()`. | ||
|
|
||
| 3) Concepts: explain how Validation works (one layer deeper than “getting started”) | ||
| - Add a Concepts landing page and an “options overview” page that explains: | ||
| where options come from, how they’re applied, and what code gets generated. | ||
| - Keep this conceptual (no option-by-option details yet). | ||
|
|
||
| 4) Built-in options: publish a minimal reference set | ||
| - From `/Users/sanders/Projects/Spine/validation/docs/_options/options.proto` and | ||
| `/Users/sanders/Projects/Spine/validation/docs/_options/time_options.proto`, | ||
| enumerate the built-in options and group them (fields, strings, numbers, collections, message-level, time). | ||
| - For each documented option: purpose, supported field types, common pitfalls, and a short `.proto` example. | ||
| - Start with the options already used in docs/examples: `(required)`, `(pattern)`, `(min)/(max)`, | ||
| `(distinct)`, `(validate)`, `(when)`. | ||
|
|
||
| 5) Runtime API usage (Java + Kotlin) | ||
| - Document the two primary usage patterns: | ||
| - fail-fast on `build()` (throws `ValidationException`); | ||
| - non-throwing `validate()` (returns `Optional<ValidationError>`). | ||
| - Link to the runtime entry points used by generated code: | ||
| `/Users/sanders/Projects/Spine/validation/jvm-runtime/src/main/java/io/spine/validation/ValidatableMessage.java`, | ||
| `/Users/sanders/Projects/Spine/validation/jvm-runtime/src/main/java/io/spine/validation/ValidatingBuilder.java`, | ||
| `/Users/sanders/Projects/Spine/validation/jvm-runtime/src/main/java/io/spine/validation/Validate.java`, | ||
| `/Users/sanders/Projects/Spine/validation/jvm-runtime/src/main/java/io/spine/validation/ValidationException.java`, | ||
| `/Users/sanders/Projects/Spine/validation/jvm-runtime/src/main/kotlin/io/spine/validation/MessageExtensions.kt`. | ||
|
|
||
| 6) Verification pass (keep it tight; fix only doc-related issues) | ||
| - From `/Users/sanders/Projects/Spine/validation/docs/`, run: | ||
| - `./gradlew embedCode` | ||
| - `./gradlew checkSamples` | ||
| - `./gradlew buildSite` | ||
| - If something fails, fix the docs, embedded snippet markers, or example sources until green. |
Binary file not shown.
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
Submodule _examples
updated
2 files
| +1 −1 | first-model/build.gradle.kts | |
| +4 −1 | first-model/src/test/kotlin/io/spine/validation/docs/firstmodel/BankCardKtTest.kt |
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.