Skip to content

Document documentation submodule internals and workflows #297

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.

Sign up for GitHub

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
alexander-yevsyukov merged 40 commits into from
May 12, 2026
Merged

Document documentation submodule internals and workflows #297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
7568a51
Use HTTPS in (c) header
alexander-yevsyukov May 11, 2026
3d3885f
Bump version -> `2.0.0-SNAPSHOT.419`
alexander-yevsyukov May 11, 2026
9e5663d
Bump Validation -> `2.0.0-SNAPSHOT.419`
alexander-yevsyukov May 11, 2026
490ae09
Add Kotlin files to `.gitattributes`
alexander-yevsyukov May 11, 2026
378f712
Draft the plan for extending documentation
alexander-yevsyukov May 11, 2026
506bed5
Rename the plan file
alexander-yevsyukov May 11, 2026
ec2320f
Refine the documentation2 plan
alexander-yevsyukov May 11, 2026
f611c48
Update the doc2 plan with discovery findings
alexander-yevsyukov May 11, 2026
698c09c
Draft the documentation2 structure
alexander-yevsyukov May 11, 2026
5205ba6
Add docs2 content
alexander-yevsyukov May 11, 2026
7691295
Add docs2 content
alexander-yevsyukov May 11, 2026
9573de5
Avoid redundant backticks
alexander-yevsyukov May 11, 2026
e07de76
Avoid redundant backticks
alexander-yevsyukov May 11, 2026
ab0336e
Describe documentation tooling
alexander-yevsyukov May 11, 2026
54446fd
Add Claude memory
alexander-yevsyukov May 11, 2026
f48ea90
Describe the documentation procedures
alexander-yevsyukov May 11, 2026
2f2ead5
Replace `GRADLE.md` with `README.md`
alexander-yevsyukov May 11, 2026
82c9c09
Improve wording of tooling and procedures
alexander-yevsyukov May 11, 2026
472b250
Simplify `embed-code-go` update description
alexander-yevsyukov May 11, 2026
5c22496
Update Claude memory
alexander-yevsyukov May 11, 2026
7c87f98
Update Claude memory
alexander-yevsyukov May 11, 2026
ae3c5cc
Add backticks around `site-commons` and `embed-code-go` repo links
alexander-yevsyukov May 11, 2026
f5f8b36
Update Claude memory
alexander-yevsyukov May 11, 2026
b257ea3
Simplify the reference to the Documentation repository
alexander-yevsyukov May 11, 2026
c90f1cc
Remove `_options` directory
alexander-yevsyukov May 11, 2026
8a7d53c
Correct the statement of the source pools for embedding
alexander-yevsyukov May 11, 2026
53aa779
Fix the correctness of wording around update procedures
alexander-yevsyukov May 11, 2026
fd4beda
Update dependency reports
alexander-yevsyukov May 11, 2026
f9b33ba
Add reference to full `embed-code-go` syntax reference
alexander-yevsyukov May 11, 2026
d878e26
Add `docs` root for embedding
alexander-yevsyukov May 11, 2026
f6cc2af
Add `time` root for embedding
alexander-yevsyukov May 11, 2026
d6f9e41
Remove task documents
alexander-yevsyukov May 11, 2026
95d25ed
Remove Claude memory
alexander-yevsyukov May 11, 2026
ee40227
Describe pushing examples in procedures
alexander-yevsyukov May 11, 2026
ce96127
Remove redundant (c) header
alexander-yevsyukov May 11, 2026
277900f
Improve wording on inlining examples
alexander-yevsyukov May 12, 2026
dd4c5db
Add link to the versioning policy
alexander-yevsyukov May 12, 2026
67981d1
Update build time
alexander-yevsyukov May 12, 2026
c1d5928
Fix the wording around server restart
alexander-yevsyukov May 12, 2026
e841b61
Use typographic quotes
alexander-yevsyukov May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ LICENSE text
# Java sources
*.java text

# Kotlin sources
*.kt text
*.kts text

# Python sources
*.py text

Expand Down
60 changes: 30 additions & 30 deletions dependencies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


# Dependencies of `io.spine.tools:validation-context:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-context:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -1090,14 +1090,14 @@

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:49 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-context-tests:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-context-tests:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -1791,28 +1791,28 @@ This report was generated on **Fri May 08 20:07:49 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:48 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-docs:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-docs:2.0.0-SNAPSHOT.416`
Comment thread
alexander-yevsyukov marked this conversation as resolved.
Comment thread
alexander-yevsyukov marked this conversation as resolved.
Comment thread
alexander-yevsyukov marked this conversation as resolved.

## Runtime
## Compile, tests, and tooling
Comment thread
alexander-yevsyukov marked this conversation as resolved.

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Thu May 07 21:35:57 WEST 2026** using
This report was generated on **Thu May 07 19:54:38 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-gradle-plugin:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-gradle-plugin:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -2864,14 +2864,14 @@ This report was generated on **Thu May 07 21:35:57 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:49 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-java:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-java:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -3961,14 +3961,14 @@ This report was generated on **Fri May 08 20:07:49 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:49 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-java-bundle:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-java-bundle:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : org.jetbrains. **Name** : annotations. **Version** : 13.0.
Expand Down Expand Up @@ -4015,14 +4015,14 @@ This report was generated on **Fri May 08 20:07:49 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:46 WEST 2026** using
This report was generated on **Tue May 12 16:13:28 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine:spine-validation-jvm-runtime:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine:spine-validation-jvm-runtime:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -4822,14 +4822,14 @@ This report was generated on **Fri May 08 20:07:46 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:49 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-consumer:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-consumer:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -5511,14 +5511,14 @@ This report was generated on **Fri May 08 20:07:49 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:48 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-consumer-dependency:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-consumer-dependency:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -5976,14 +5976,14 @@ This report was generated on **Fri May 08 20:07:48 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:48 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-extensions:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-extensions:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -6602,14 +6602,14 @@ This report was generated on **Fri May 08 20:07:48 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:48 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-runtime:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-runtime:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -7170,14 +7170,14 @@ This report was generated on **Fri May 08 20:07:48 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:48 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-validating:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-validating:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -7781,14 +7781,14 @@ This report was generated on **Fri May 08 20:07:48 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:48 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-validator:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-validator:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.fasterxml.jackson. **Name** : jackson-bom. **Version** : 2.20.0.
Expand Down Expand Up @@ -8526,14 +8526,14 @@ This report was generated on **Fri May 08 20:07:48 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:48 WEST 2026** using
This report was generated on **Tue May 12 16:13:31 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-validator-dependency:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-validator-dependency:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -8766,14 +8766,14 @@ This report was generated on **Fri May 08 20:07:48 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:47 WEST 2026** using
This report was generated on **Tue May 12 16:13:30 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).




# Dependencies of `io.spine.tools:validation-vanilla:2.0.0-SNAPSHOT.418`
# Dependencies of `io.spine.tools:validation-vanilla:2.0.0-SNAPSHOT.419`

## Runtime
1. **Group** : com.google.code.findbugs. **Name** : jsr305. **Version** : 3.0.2.
Expand Down Expand Up @@ -9116,6 +9116,6 @@ This report was generated on **Fri May 08 20:07:47 WEST 2026** using

The dependencies distributed under several licenses, are used according their commercial-use-friendly license.

This report was generated on **Fri May 08 20:07:47 WEST 2026** using
This report was generated on **Tue May 12 16:13:30 WEST 2026** using
[Gradle-License-Report plugin](https://github.com/jk1/Gradle-License-Report) by Evgeny Naumenko, licensed under
[Apache 2.0 License](https://github.com/jk1/Gradle-License-Report/blob/master/LICENSE).
62 changes: 0 additions & 62 deletions docs/GRADLE.md
View file
Open in desktop

This file was deleted.

22 changes: 22 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Spine Validation — `docs/` module

This directory hosts the source of the Spine Validation documentation.
It is a Hugo project supplemented by Gradle wiring and a Go-based
code-embedding tool. The content under `content/` and `data/` is the
contributor-editable source; the rest of the directories — `_preview/`,
`_examples/`, `_time/`, `_settings/`, `_script/`, `_bin/` —
support local rendering, code embedding, and the example projects the
documentation references.

The `docs/` module is a **staging area**, not a published site. Content
under `content/` is merged into the main documentation project at
[SpineEventEngine/documentation][main-documentation] and published from
there to the spine.io website.

For the full technical description of the documentation pipeline — the
Gradle tasks, the embedded-examples mechanism, the external tooling, and
the recurring contributor procedures — see the in-repository overview at
[content/docs/validation/developer/documentation/_index.md][overview].

[main-documentation]: https://github.com/SpineEventEngine/documentation
[overview]: content/docs/validation/developer/documentation/_index.md
2 changes: 1 addition & 1 deletion docs/_examples
Open in desktop
Submodule _examples updated 2 files
+1 −1 external/build.gradle.kts
+1 −1 first-model/build.gradle.kts
Loading
Loading