Skip to content

Commit 90f21e4

Browse files
Address the first task from the plan
1 parent ab82bf8 commit 90f21e4

10 files changed

Lines changed: 66 additions & 17 deletions

File tree

.agents/tasks/validation-documentation-plan.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,21 @@ buildable documentation set, without expanding scope unnecessarily.
2323
## Minimal task list (in order)
2424

2525
1) Information architecture (IA): make Hugo navigation coherent
26-
- Ensure section landing pages and “What’s next” links provide an obvious reading path
27-
under `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/`.
28-
- Fix obvious broken intra-doc links.
26+
- Status: DONE (2026-02-23).
27+
- Added/updated section landing pages:
28+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/_index.md`
29+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/developers-guide/_index.md`
30+
- Replaced broken `.../index.md` links with directory links where appropriate:
31+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/00-intro/_index.md`
32+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/01-getting-started/_index.md`
33+
- Added “What’s next” navigation to keep a clear reading path:
34+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/00-intro/target-audience.md`
35+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/00-intro/philosophy.md`
36+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/developers-guide/architecture.md`
37+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/developers-guide/key-modules.md`
38+
- `/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/01-getting-started/first-model.md`
39+
- Fixed an obvious broken image reference:
40+
`/Users/sanders/Projects/Spine/validation/docs/content/docs/validation/adding-custom-validation.md`
2941

3042
2) Complete “Getting started” flow
3143
- Validate that “Adding to build” + “First model” cover:

docs/content/docs/validation/00-intro/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,4 +115,4 @@ Spine stack.
115115

116116
- [Target audience](target-audience.md)
117117
- [Philosophy](philosophy.md)
118-
- [Getting Started](../01-getting-started/index.md)
118+
- [Getting started](../01-getting-started/)

docs/content/docs/validation/00-intro/philosophy.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,8 @@ Spine Validation is principled around:
136136

137137
This makes it suitable for teams that need reliable, maintainable,
138138
and evolvable validation for complex systems built on top of Protobuf.
139+
140+
## What’s next
141+
142+
- Who this is for: [Target audience](target-audience.md).
143+
- Try it end-to-end: [Getting started](../01-getting-started/).

docs/content/docs/validation/00-intro/target-audience.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,8 @@ If you:
9696
- and want to enforce clear, versionable, and strongly typed validation rules,
9797

9898
then Spine Validation is designed for you.
99+
100+
## What’s next
101+
102+
- Learn the design principles: [Philosophy](philosophy.md).
103+
- Try it end-to-end: [Getting started](../01-getting-started/).

docs/content/docs/validation/01-getting-started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section helps you set up Spine Validation, define your first validated Prot
44
and see validation in action in Java and Kotlin.
55

66
If you are new to the library, read the short overview first:
7-
- Introduction → [Overview](../00-intro/index.md)
7+
- Introduction → [Overview](../00-intro/)
88
- Who this is for → [Target audience](../00-intro/target-audience.md)
99
- Design principles → [Philosophy](../00-intro/philosophy.md)
1010

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1-
---
2-
build:
3-
render: never
4-
---
1+
# Spine Validation
2+
3+
Spine Validation generates type-safe validation code from constraints declared in Protobuf
4+
options, and runs those checks automatically when you build messages.
5+
6+
## Start here
7+
8+
- New to the library: [Overview](00-intro/)
9+
- Ready to try it: [Getting started](01-getting-started/)
10+
11+
## Deeper topics
12+
13+
- How it works: [Architecture](developers-guide/architecture.md)
14+
- Extension points: [Adding custom validation](adding-custom-validation.md)

docs/content/docs/validation/adding-custom-validation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@ Follow these steps to create a custom option:
1515

1616
Below is a workflow diagram for a typical option:
1717

18-
![Typical custom option](.github/readme/typical_custom_option.png)
18+
![Typical custom option](.github/readme/typical_custom_option.jpg)
19+
20+
## What’s next
21+
22+
- Learn where this plugs in: [Architecture](developers-guide/architecture.md).
1923

2024
Take a look at the `:java-tests:extensions` module that contains a full example of
2125
implementation of the custom `(currency)` option.
Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
---
2-
build:
3-
render: never
4-
---
1+
# Developer’s guide
2+
3+
This section explains how Spine Validation is structured internally and where to look when
4+
you need to extend it.
5+
6+
## Topics
7+
8+
- [Architecture](architecture.md)
9+
- [Key modules](key-modules.md)

docs/content/docs/validation/developers-guide/architecture.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Architecture
1+
# Architecture
22

33
The library is a set of plugins for [Spine Compiler](https://github.com/SpineEventEngine/compiler).
44

@@ -14,3 +14,8 @@ The workflow is the following:
1414
- (3) – Protobuf compiler generates Java classes.
1515
- (4), (5) – policies and views build the validation model.
1616
- (6), (7) – Java plugin generates and injects validation code.
17+
18+
## What’s next
19+
20+
- See the project layout: [Key modules](key-modules.md).
21+
- If you need organization-specific rules: [Adding custom validation](../adding-custom-validation.md).
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
2-
### Key modules
1+
# Key modules
32

43
| Module | Description |
54
|-----------|----------------------------------------------------------------------|
65
| :model | The language-agnostic model for the built-in options. |
76
| :java | Generates and injects Java validation code based on applied options. |
87
| :java-api | Extension API for custom options in Java. |
8+
9+
## What’s next
10+
11+
- Build custom constraints: [Adding custom validation](../adding-custom-validation.md).

0 commit comments

Comments
 (0)