From 91cbf5344b1a905d21e0102815b2d6331cbe0c7f Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Fri, 6 Feb 2026 18:04:26 +0100 Subject: [PATCH 01/10] Get updates from `site-commons` and remove styles --- docs/_preview/assets/scss/docs/_home.scss | 64 --------------------- docs/_preview/assets/scss/docs/_layout.scss | 37 ------------ docs/_preview/assets/scss/main.scss | 36 ------------ docs/_preview/content/{docs => }/_index.md | 7 ++- docs/_preview/go.mod | 5 +- docs/_preview/go.sum | 8 ++- docs/_preview/hugo.toml | 21 ++----- docs/_preview/package-lock.json | 31 ---------- docs/_preview/package.json | 3 - docs/_preview/postcss.config.js | 22 +++++++ docs/content/_index.md | 4 ++ docs/content/docs/validation/_index.md | 4 ++ 12 files changed, 50 insertions(+), 192 deletions(-) delete mode 100644 docs/_preview/assets/scss/docs/_home.scss delete mode 100644 docs/_preview/assets/scss/docs/_layout.scss delete mode 100644 docs/_preview/assets/scss/main.scss rename docs/_preview/content/{docs => }/_index.md (57%) create mode 100644 docs/_preview/postcss.config.js create mode 100644 docs/content/_index.md create mode 100644 docs/content/docs/validation/_index.md diff --git a/docs/_preview/assets/scss/docs/_home.scss b/docs/_preview/assets/scss/docs/_home.scss deleted file mode 100644 index 3f5ad7b14..000000000 --- a/docs/_preview/assets/scss/docs/_home.scss +++ /dev/null @@ -1,64 +0,0 @@ -/*! - * Copyright 2025, 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 - * - * Redistribution and use in source and/or binary forms, with or without - * modification, must retain the above copyright notice and the following - * disclaimer. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -.home { - background-color: $body-light-gray-color; - font-family: $main-font; - - .container { - background-color: white; - border: 1px solid #e6ecf1; - max-width: 760px; - padding: 48px 56px; - - @include breakpoint(md-phone) { - padding: 24px; - } - - h1 { - font-size: $font-size--xxxl; - font-weight: 300; - color: rgba(0, 0, 0, .4); - line-height: 1.2; - margin-bottom: 32px; - padding-top: 16px; - - @include breakpoint(md-phone) { - font-size: $font-size--xl; - } - } - - a { - color: $main-brand-color; - } - - .subtle { - color: rgba(0, 0, 0, .46); - margin-top: 40px; - font-size: 14px; - } - } -} diff --git a/docs/_preview/assets/scss/docs/_layout.scss b/docs/_preview/assets/scss/docs/_layout.scss deleted file mode 100644 index 88a770404..000000000 --- a/docs/_preview/assets/scss/docs/_layout.scss +++ /dev/null @@ -1,37 +0,0 @@ -/*! - * Copyright 2025, 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 - * - * Redistribution and use in source and/or binary forms, with or without - * modification, must retain the above copyright notice and the following - * disclaimer. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -.page-content { - .three-column { - .sticky-col { - top: 0; - } - - .content-col { - padding-bottom: 20px; - } - } -} diff --git a/docs/_preview/assets/scss/main.scss b/docs/_preview/assets/scss/main.scss deleted file mode 100644 index f687a3b6d..000000000 --- a/docs/_preview/assets/scss/main.scss +++ /dev/null @@ -1,36 +0,0 @@ -/*! - * Copyright 2025, 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 - * - * Redistribution and use in source and/or binary forms, with or without - * modification, must retain the above copyright notice and the following - * disclaimer. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - */ - -@import "node_modules/bootstrap/scss/bootstrap"; - -@import "docs-common"; -@import "docs"; - -// Styles that should only be used to build this site. -// They should not be imported into the main spine.io site -// to not override or duplicate styles there. -@import "docs/home"; -@import "docs/layout"; diff --git a/docs/_preview/content/docs/_index.md b/docs/_preview/content/_index.md similarity index 57% rename from docs/_preview/content/docs/_index.md rename to docs/_preview/content/_index.md index b35071d89..3901b32a0 100644 --- a/docs/_preview/content/docs/_index.md +++ b/docs/_preview/content/_index.md @@ -4,11 +4,12 @@ title: Validation Documentation preview # Welcome to Validation Documentation -Go to the [docs/](docs/) to preview the rendered documentation. +Go to the [docs/](docs/00-intro) to preview the rendered documentation. Read the [Authoring][authoring] guide on adding the content to the documentation. -

This page is only available on this preview site and will not be -rendered on spine.io.

+This page is only available on this preview site and will not be +rendered on [spine.io](https://spine.io). +{class="subtle"} [authoring]: https://github.com/SpineEventEngine/SpineEventEngine.github.io/blob/master/AUTHORING.md diff --git a/docs/_preview/go.mod b/docs/_preview/go.mod index b620f3f6e..1be18e047 100644 --- a/docs/_preview/go.mod +++ b/docs/_preview/go.mod @@ -2,4 +2,7 @@ module spine.io/validation/docs/preview go 1.25.6 -require github.com/SpineEventEngine/site-commons v0.0.0-20260203112455-f2654efc9127 // indirect +require ( + github.com/SpineEventEngine/site-commons v0.0.0-20260206165903-938d327aa42b // indirect + github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 // indirect +) diff --git a/docs/_preview/go.sum b/docs/_preview/go.sum index c64c86182..45afd9d6d 100644 --- a/docs/_preview/go.sum +++ b/docs/_preview/go.sum @@ -1,2 +1,6 @@ -github.com/SpineEventEngine/site-commons v0.0.0-20260203112455-f2654efc9127 h1:uIbC8yEB3A/9g5HShNsBpqhmfRlxGpkWcDCbqWjCPH0= -github.com/SpineEventEngine/site-commons v0.0.0-20260203112455-f2654efc9127/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/SpineEventEngine/site-commons v0.0.0-20260206165903-938d327aa42b h1:LehkKvKW9M4Jzf0/gopHJfzCJ3QEAQfHJjQIewMhjik= +github.com/SpineEventEngine/site-commons v0.0.0-20260206165903-938d327aa42b/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 h1:L6+F22i76xmeWWwrtijAhUbf3BiRLmpO5j34bgl1ggU= +github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400/go.mod h1:uekq1D4ebeXgduLj8VIZy8TgfTjrLdSl6nPtVczso78= +github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000/go.mod h1:mFberT6ZtcchrsDtfvJM7aAH2bDKLdOnruUHl0hlapI= +github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/docs/_preview/hugo.toml b/docs/_preview/hugo.toml index 513371ff2..c0663a1ef 100644 --- a/docs/_preview/hugo.toml +++ b/docs/_preview/hugo.toml @@ -6,28 +6,19 @@ disableKinds = ['taxonomy', 'term'] [module] # First theme has higher priority than later ones. [[module.imports]] - path = 'github.com/SpineEventEngine/site-commons' - + path = '../..' [[module.imports]] - path = 'github.com/SpineEventEngine/validation/docs' - [[module.imports.mounts]] - source = 'content' - target = 'content' - [[module.imports.mounts]] - source = 'layouts' - target = 'layouts' - [[module.imports.mounts]] - source = 'assets' - target = 'assets' - [[module.imports.mounts]] - source = 'static' - target = 'static' + path = 'github.com/SpineEventEngine/site-commons' # Enables HTML rendering in markdown files. [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true + [markup.goldmark.parser] + [markup.goldmark.parser.attribute] + block = true + title = true [markup.highlight] noClasses = false diff --git a/docs/_preview/package-lock.json b/docs/_preview/package-lock.json index 0812faa82..c51457379 100644 --- a/docs/_preview/package-lock.json +++ b/docs/_preview/package-lock.json @@ -8,9 +8,6 @@ "name": "spine-docs", "version": "1.0.0", "license": "ISC", - "dependencies": { - "bootstrap": "^5.3.8" - }, "devDependencies": { "@fullhuman/postcss-purgecss": "^7.0.2", "autoprefixer": "^10.4.22", @@ -148,16 +145,6 @@ "url": "https://github.com/chalk/wrap-ansi?sponsor=1" } }, - "node_modules/@popperjs/core": { - "version": "2.11.8", - "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.8.tgz", - "integrity": "sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A==", - "peer": true, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/popperjs" - } - }, "node_modules/ansi-regex": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", @@ -253,24 +240,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/bootstrap": { - "version": "5.3.8", - "resolved": "https://registry.npmjs.org/bootstrap/-/bootstrap-5.3.8.tgz", - "integrity": "sha512-HP1SZDqaLDPwsNiqRqi5NcP0SSXciX2s9E+RyqJIIqGo+vJeN5AJVM98CXmW/Wux0nQ5L7jeWUdplCEf0Ee+tg==", - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/twbs" - }, - { - "type": "opencollective", - "url": "https://opencollective.com/bootstrap" - } - ], - "peerDependencies": { - "@popperjs/core": "^2.11.8" - } - }, "node_modules/braces": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", diff --git a/docs/_preview/package.json b/docs/_preview/package.json index 343a8ff82..143fef495 100644 --- a/docs/_preview/package.json +++ b/docs/_preview/package.json @@ -14,8 +14,5 @@ "postcss": "^8.5.6", "postcss-cli": "^11.0.1", "postcss-discard-comments": "^7.0.5" - }, - "dependencies": { - "bootstrap": "^5.3.8" } } diff --git a/docs/_preview/postcss.config.js b/docs/_preview/postcss.config.js new file mode 100644 index 000000000..a69ff3e41 --- /dev/null +++ b/docs/_preview/postcss.config.js @@ -0,0 +1,22 @@ +/** + * Adds vendor prefixes to CSS. + * + * See the `.browserslistrc` file in the root for the actual list of browsers, + * where `> 0.5%` means all browsers that are used by more than 0.5% + * of users worldwide. See https://github.com/browserslist/browserslist#queries. + */ +const autoprefixer = require('autoprefixer'); + +/** + * Discards comments from the CSS. + * + * See https://www.npmjs.com/package/postcss-discard-comments. + */ +const discardComments = require('postcss-discard-comments'); + +module.exports = { + plugins: [ + autoprefixer, + discardComments({removeAllButFirst: true}) + ] +} diff --git a/docs/content/_index.md b/docs/content/_index.md new file mode 100644 index 000000000..0b156267e --- /dev/null +++ b/docs/content/_index.md @@ -0,0 +1,4 @@ +--- +build: + render: never +--- diff --git a/docs/content/docs/validation/_index.md b/docs/content/docs/validation/_index.md new file mode 100644 index 000000000..0b156267e --- /dev/null +++ b/docs/content/docs/validation/_index.md @@ -0,0 +1,4 @@ +--- +build: + render: never +--- From a97955870d7ba9659b7cdf2ab26f9943f8c70774 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Fri, 6 Feb 2026 18:10:55 +0100 Subject: [PATCH 02/10] Remove the obsolete config --- docs/hugo.toml | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 docs/hugo.toml diff --git a/docs/hugo.toml b/docs/hugo.toml deleted file mode 100644 index 864881995..000000000 --- a/docs/hugo.toml +++ /dev/null @@ -1,6 +0,0 @@ -[params] - defaultCodeTheme = 'dark' - -# The third-party libraries from the `site-commons`. -[params.libs.js_cookie] - enabled = true From 24c9f79ec59fc06d61e6299a98ebac2c81a7f67a Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Fri, 6 Feb 2026 18:15:27 +0100 Subject: [PATCH 03/10] Make index pages as sections to be able to render child pages --- docs/content/docs/validation/00-intro/{index.md => _index.md} | 0 .../validation/01-getting-started/{index.md => _index.md} | 0 docs/content/docs/validation/developers-guide/_index.md | 4 ++++ 3 files changed, 4 insertions(+) rename docs/content/docs/validation/00-intro/{index.md => _index.md} (100%) rename docs/content/docs/validation/01-getting-started/{index.md => _index.md} (100%) create mode 100644 docs/content/docs/validation/developers-guide/_index.md diff --git a/docs/content/docs/validation/00-intro/index.md b/docs/content/docs/validation/00-intro/_index.md similarity index 100% rename from docs/content/docs/validation/00-intro/index.md rename to docs/content/docs/validation/00-intro/_index.md diff --git a/docs/content/docs/validation/01-getting-started/index.md b/docs/content/docs/validation/01-getting-started/_index.md similarity index 100% rename from docs/content/docs/validation/01-getting-started/index.md rename to docs/content/docs/validation/01-getting-started/_index.md diff --git a/docs/content/docs/validation/developers-guide/_index.md b/docs/content/docs/validation/developers-guide/_index.md new file mode 100644 index 000000000..0b156267e --- /dev/null +++ b/docs/content/docs/validation/developers-guide/_index.md @@ -0,0 +1,4 @@ +--- +build: + render: never +--- From fd7aa024bff8f1a3fda8cc3c6a6be3892ad27207 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Fri, 6 Feb 2026 18:39:14 +0100 Subject: [PATCH 04/10] Remove the version configuration for now to render the documentation under `validation` --- docs/_preview/content/_index.md | 2 +- docs/_preview/go.mod | 2 +- docs/_preview/go.sum | 4 ++-- docs/_preview/hugo.toml | 29 ----------------------------- docs/content/docs/_index.md | 4 ++++ 5 files changed, 8 insertions(+), 33 deletions(-) create mode 100644 docs/content/docs/_index.md diff --git a/docs/_preview/content/_index.md b/docs/_preview/content/_index.md index 3901b32a0..84d6c9fec 100644 --- a/docs/_preview/content/_index.md +++ b/docs/_preview/content/_index.md @@ -4,7 +4,7 @@ title: Validation Documentation preview # Welcome to Validation Documentation -Go to the [docs/](docs/00-intro) to preview the rendered documentation. +Go to the [docs/validation/](docs/validation/00-intro/) to preview the rendered documentation. Read the [Authoring][authoring] guide on adding the content to the documentation. diff --git a/docs/_preview/go.mod b/docs/_preview/go.mod index 1be18e047..aed86b930 100644 --- a/docs/_preview/go.mod +++ b/docs/_preview/go.mod @@ -3,6 +3,6 @@ module spine.io/validation/docs/preview go 1.25.6 require ( - github.com/SpineEventEngine/site-commons v0.0.0-20260206165903-938d327aa42b // indirect + github.com/SpineEventEngine/site-commons v0.0.0-20260206173716-02e39c6571e5 // indirect github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 // indirect ) diff --git a/docs/_preview/go.sum b/docs/_preview/go.sum index 45afd9d6d..e0d03606b 100644 --- a/docs/_preview/go.sum +++ b/docs/_preview/go.sum @@ -1,5 +1,5 @@ -github.com/SpineEventEngine/site-commons v0.0.0-20260206165903-938d327aa42b h1:LehkKvKW9M4Jzf0/gopHJfzCJ3QEAQfHJjQIewMhjik= -github.com/SpineEventEngine/site-commons v0.0.0-20260206165903-938d327aa42b/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/SpineEventEngine/site-commons v0.0.0-20260206173716-02e39c6571e5 h1:Ecu6nuJp6tSvIKG9bdSqKTqTqD5/U50y9/WQ63pTMEM= +github.com/SpineEventEngine/site-commons v0.0.0-20260206173716-02e39c6571e5/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 h1:L6+F22i76xmeWWwrtijAhUbf3BiRLmpO5j34bgl1ggU= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400/go.mod h1:uekq1D4ebeXgduLj8VIZy8TgfTjrLdSl6nPtVczso78= github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000/go.mod h1:mFberT6ZtcchrsDtfvJM7aAH2bDKLdOnruUHl0hlapI= diff --git a/docs/_preview/hugo.toml b/docs/_preview/hugo.toml index c0663a1ef..a4fa61704 100644 --- a/docs/_preview/hugo.toml +++ b/docs/_preview/hugo.toml @@ -21,32 +21,3 @@ disableKinds = ['taxonomy', 'term'] title = true [markup.highlight] noClasses = false - -# Version control config. -# To change the current main version, update only the `path` parameter. -# Read more in the `SPINE_RELEASE.md` guide. -# -# The same settings should be copied to the `SpineEventEngine/SpineEventEngine.github.io` -# project due to the issue with the cascade arrays: -# https://github.com/gohugoio/hugo/issues/13869 -[[cascade]] - [cascade.params] - url = 'docs/' - [cascade.target] - # The path to the `_index.md` of the current main version. - path = '{/docs}' - kind = 'section' -[[cascade]] - [cascade.params] - url = 'docs/:sections[2:]/' - [cascade.target] - # The path to the current main version. - path = '{/docs/**}' - kind = 'section' -[[cascade]] - [cascade.params] - url = 'docs/:sections[2:]/:contentbasename/' - [cascade.target] - # The path to the current main version. - path = '{/docs/**}' - kind = 'page' diff --git a/docs/content/docs/_index.md b/docs/content/docs/_index.md new file mode 100644 index 000000000..0b156267e --- /dev/null +++ b/docs/content/docs/_index.md @@ -0,0 +1,4 @@ +--- +build: + render: never +--- From 60a14eee8d44a77279e3080bd9dd0cb1b989dedb Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Mon, 9 Feb 2026 19:56:54 +0100 Subject: [PATCH 05/10] Configure the "Validation" sidenav to bring it to the "documentation" repository --- docs/_preview/go.mod | 2 +- docs/_preview/go.sum | 4 ++-- docs/data/docs/validation/1/sidenav.yml | 13 +++++++++++++ docs/data/versions.yml | 9 +++++++++ 4 files changed, 25 insertions(+), 3 deletions(-) create mode 100644 docs/data/docs/validation/1/sidenav.yml create mode 100644 docs/data/versions.yml diff --git a/docs/_preview/go.mod b/docs/_preview/go.mod index aed86b930..f6dd830c2 100644 --- a/docs/_preview/go.mod +++ b/docs/_preview/go.mod @@ -3,6 +3,6 @@ module spine.io/validation/docs/preview go 1.25.6 require ( - github.com/SpineEventEngine/site-commons v0.0.0-20260206173716-02e39c6571e5 // indirect + github.com/SpineEventEngine/site-commons v0.0.0-20260209185245-baa4a2ee9e21 // indirect github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 // indirect ) diff --git a/docs/_preview/go.sum b/docs/_preview/go.sum index e0d03606b..a2b37b509 100644 --- a/docs/_preview/go.sum +++ b/docs/_preview/go.sum @@ -1,5 +1,5 @@ -github.com/SpineEventEngine/site-commons v0.0.0-20260206173716-02e39c6571e5 h1:Ecu6nuJp6tSvIKG9bdSqKTqTqD5/U50y9/WQ63pTMEM= -github.com/SpineEventEngine/site-commons v0.0.0-20260206173716-02e39c6571e5/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/SpineEventEngine/site-commons v0.0.0-20260209185245-baa4a2ee9e21 h1:HiG6Rix8Z+AUcSaaFd/YWTE73FEk5PrkiZIu1BpOkiM= +github.com/SpineEventEngine/site-commons v0.0.0-20260209185245-baa4a2ee9e21/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 h1:L6+F22i76xmeWWwrtijAhUbf3BiRLmpO5j34bgl1ggU= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400/go.mod h1:uekq1D4ebeXgduLj8VIZy8TgfTjrLdSl6nPtVczso78= github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000/go.mod h1:mFberT6ZtcchrsDtfvJM7aAH2bDKLdOnruUHl0hlapI= diff --git a/docs/data/docs/validation/1/sidenav.yml b/docs/data/docs/validation/1/sidenav.yml new file mode 100644 index 000000000..fd6a4ad07 --- /dev/null +++ b/docs/data/docs/validation/1/sidenav.yml @@ -0,0 +1,13 @@ +# The `file_path` should be relative to the `docs/validation`. +# Thanks to this, links to the version will be generated automatically. +# Also, the `file_path` must not end with a trailing slash. + +- page: Validation + key: validation + children: + - page: Adding custom validation + file_path: adding-custom-validation + - page: Overview + file_path: 00-intro + - page: Philosophy + file_path: 00-intro/philosophy diff --git a/docs/data/versions.yml b/docs/data/versions.yml new file mode 100644 index 000000000..33aae4863 --- /dev/null +++ b/docs/data/versions.yml @@ -0,0 +1,9 @@ +validation: + - short: "1" + full: 1.0.0 + path: docs/validation + url: docs/validation + is_main: true + switcher: + visible: false + item_visible: false From dfc60c875a3185e7e53884ec59e6ea3e2eddabbc Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Tue, 10 Feb 2026 18:14:19 +0100 Subject: [PATCH 06/10] Get latest theme updates with the proper link rendering --- docs/_preview/go.mod | 2 +- docs/_preview/go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_preview/go.mod b/docs/_preview/go.mod index f6dd830c2..9ed1c3229 100644 --- a/docs/_preview/go.mod +++ b/docs/_preview/go.mod @@ -3,6 +3,6 @@ module spine.io/validation/docs/preview go 1.25.6 require ( - github.com/SpineEventEngine/site-commons v0.0.0-20260209185245-baa4a2ee9e21 // indirect + github.com/SpineEventEngine/site-commons v0.0.0-20260210154705-538d1ec89ea4 // indirect github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 // indirect ) diff --git a/docs/_preview/go.sum b/docs/_preview/go.sum index a2b37b509..258695a6b 100644 --- a/docs/_preview/go.sum +++ b/docs/_preview/go.sum @@ -1,5 +1,5 @@ -github.com/SpineEventEngine/site-commons v0.0.0-20260209185245-baa4a2ee9e21 h1:HiG6Rix8Z+AUcSaaFd/YWTE73FEk5PrkiZIu1BpOkiM= -github.com/SpineEventEngine/site-commons v0.0.0-20260209185245-baa4a2ee9e21/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/SpineEventEngine/site-commons v0.0.0-20260210154705-538d1ec89ea4 h1:7maYB9zQhCE+TLOCxa3tcndLmh/yDpl3i5V+0HCVQQ0= +github.com/SpineEventEngine/site-commons v0.0.0-20260210154705-538d1ec89ea4/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 h1:L6+F22i76xmeWWwrtijAhUbf3BiRLmpO5j34bgl1ggU= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400/go.mod h1:uekq1D4ebeXgduLj8VIZy8TgfTjrLdSl6nPtVczso78= github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000/go.mod h1:mFberT6ZtcchrsDtfvJM7aAH2bDKLdOnruUHl0hlapI= From 291e63967463c6a8f26ecb33c91b22e9dc44a4b6 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Wed, 11 Feb 2026 17:43:54 +0100 Subject: [PATCH 07/10] Get theme updates and delete additional CSS config files --- docs/_preview/.browserslistrc | 3 --- docs/_preview/go.mod | 4 +++- docs/_preview/go.sum | 7 +++++-- docs/_preview/postcss.config.js | 22 ---------------------- docs/data/docs/validation/1/sidenav.yml | 2 -- 5 files changed, 8 insertions(+), 30 deletions(-) delete mode 100644 docs/_preview/.browserslistrc delete mode 100644 docs/_preview/postcss.config.js diff --git a/docs/_preview/.browserslistrc b/docs/_preview/.browserslistrc deleted file mode 100644 index e99637812..000000000 --- a/docs/_preview/.browserslistrc +++ /dev/null @@ -1,3 +0,0 @@ -> 0.5% -last 2 versions -not dead diff --git a/docs/_preview/go.mod b/docs/_preview/go.mod index 9ed1c3229..f27bfc997 100644 --- a/docs/_preview/go.mod +++ b/docs/_preview/go.mod @@ -3,6 +3,8 @@ module spine.io/validation/docs/preview go 1.25.6 require ( - github.com/SpineEventEngine/site-commons v0.0.0-20260210154705-538d1ec89ea4 // indirect + github.com/SpineEventEngine/site-commons v0.0.0-20260211163733-7638d91cd24a // indirect github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 // indirect + github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000 // indirect + github.com/twbs/bootstrap v5.3.8+incompatible // indirect ) diff --git a/docs/_preview/go.sum b/docs/_preview/go.sum index 258695a6b..d0b1abc76 100644 --- a/docs/_preview/go.sum +++ b/docs/_preview/go.sum @@ -1,6 +1,9 @@ -github.com/SpineEventEngine/site-commons v0.0.0-20260210154705-538d1ec89ea4 h1:7maYB9zQhCE+TLOCxa3tcndLmh/yDpl3i5V+0HCVQQ0= -github.com/SpineEventEngine/site-commons v0.0.0-20260210154705-538d1ec89ea4/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/SpineEventEngine/site-commons v0.0.0-20260211163733-7638d91cd24a h1:dtdrMuQCQpyMJh/m9xAJ8bTUIAtrGfsTnBWrfznyeqc= +github.com/SpineEventEngine/site-commons v0.0.0-20260211163733-7638d91cd24a/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 h1:L6+F22i76xmeWWwrtijAhUbf3BiRLmpO5j34bgl1ggU= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400/go.mod h1:uekq1D4ebeXgduLj8VIZy8TgfTjrLdSl6nPtVczso78= +github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000 h1:GZxx4Hc+yb0/t3/rau1j8XlAxLE4CyXns2fqQbyqWfs= github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000/go.mod h1:mFberT6ZtcchrsDtfvJM7aAH2bDKLdOnruUHl0hlapI= github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.8+incompatible h1:eK1fsXP7R/FWFt+sSNmmvUH9usPocf240nWVw7Dh02o= +github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/docs/_preview/postcss.config.js b/docs/_preview/postcss.config.js deleted file mode 100644 index a69ff3e41..000000000 --- a/docs/_preview/postcss.config.js +++ /dev/null @@ -1,22 +0,0 @@ -/** - * Adds vendor prefixes to CSS. - * - * See the `.browserslistrc` file in the root for the actual list of browsers, - * where `> 0.5%` means all browsers that are used by more than 0.5% - * of users worldwide. See https://github.com/browserslist/browserslist#queries. - */ -const autoprefixer = require('autoprefixer'); - -/** - * Discards comments from the CSS. - * - * See https://www.npmjs.com/package/postcss-discard-comments. - */ -const discardComments = require('postcss-discard-comments'); - -module.exports = { - plugins: [ - autoprefixer, - discardComments({removeAllButFirst: true}) - ] -} diff --git a/docs/data/docs/validation/1/sidenav.yml b/docs/data/docs/validation/1/sidenav.yml index fd6a4ad07..9f96fdd71 100644 --- a/docs/data/docs/validation/1/sidenav.yml +++ b/docs/data/docs/validation/1/sidenav.yml @@ -5,8 +5,6 @@ - page: Validation key: validation children: - - page: Adding custom validation - file_path: adding-custom-validation - page: Overview file_path: 00-intro - page: Philosophy From 54f07fbfbe098653752ff242b64cffc8d2c0c061 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Wed, 11 Feb 2026 18:23:18 +0100 Subject: [PATCH 08/10] Get theme updates with the common data variables --- docs/_preview/go.mod | 2 +- docs/_preview/go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_preview/go.mod b/docs/_preview/go.mod index f27bfc997..c40d1ccea 100644 --- a/docs/_preview/go.mod +++ b/docs/_preview/go.mod @@ -3,7 +3,7 @@ module spine.io/validation/docs/preview go 1.25.6 require ( - github.com/SpineEventEngine/site-commons v0.0.0-20260211163733-7638d91cd24a // indirect + github.com/SpineEventEngine/site-commons v0.0.0-20260211172012-ed1994c0c0f3 // indirect github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 // indirect github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000 // indirect github.com/twbs/bootstrap v5.3.8+incompatible // indirect diff --git a/docs/_preview/go.sum b/docs/_preview/go.sum index d0b1abc76..0388cdb9f 100644 --- a/docs/_preview/go.sum +++ b/docs/_preview/go.sum @@ -1,5 +1,5 @@ -github.com/SpineEventEngine/site-commons v0.0.0-20260211163733-7638d91cd24a h1:dtdrMuQCQpyMJh/m9xAJ8bTUIAtrGfsTnBWrfznyeqc= -github.com/SpineEventEngine/site-commons v0.0.0-20260211163733-7638d91cd24a/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= +github.com/SpineEventEngine/site-commons v0.0.0-20260211172012-ed1994c0c0f3 h1:Fweb3jJxf9gpjKEBlOAAaFHzlju4qnGlxj/3UJaa7UA= +github.com/SpineEventEngine/site-commons v0.0.0-20260211172012-ed1994c0c0f3/go.mod h1:tkAl4StIREKmz9r5PiJtuDhvwMMkFXKWcaTyxhIikho= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400 h1:L6+F22i76xmeWWwrtijAhUbf3BiRLmpO5j34bgl1ggU= github.com/gohugoio/hugo-mod-bootstrap-scss/v5 v5.20300.20400/go.mod h1:uekq1D4ebeXgduLj8VIZy8TgfTjrLdSl6nPtVczso78= github.com/gohugoio/hugo-mod-jslibs-dist/popperjs/v2 v2.21100.20000 h1:GZxx4Hc+yb0/t3/rau1j8XlAxLE4CyXns2fqQbyqWfs= From d80c84f11d6d6af72f7920c0c58139d2de70631e Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Wed, 11 Feb 2026 19:18:22 +0100 Subject: [PATCH 09/10] Update the version config for `major` version --- docs/data/versions.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/data/versions.yml b/docs/data/versions.yml index 33aae4863..8fd4a8120 100644 --- a/docs/data/versions.yml +++ b/docs/data/versions.yml @@ -1,6 +1,6 @@ validation: - - short: "1" - full: 1.0.0 + - short: "2" + full: 2.0.0-SNAPSHOT path: docs/validation url: docs/validation is_main: true From 7a964de7cb68e98c9b41c0d51902a3703bb655b9 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Wed, 11 Feb 2026 19:19:20 +0100 Subject: [PATCH 10/10] Place the sidenav in the corresponding folder --- docs/data/docs/validation/{1 => 2}/sidenav.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/data/docs/validation/{1 => 2}/sidenav.yml (100%) diff --git a/docs/data/docs/validation/1/sidenav.yml b/docs/data/docs/validation/2/sidenav.yml similarity index 100% rename from docs/data/docs/validation/1/sidenav.yml rename to docs/data/docs/validation/2/sidenav.yml