From b184e4d3d3385a8c2bad9ef4dd5dbc5c76391f6e Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Thu, 12 Feb 2026 15:29:47 +0100 Subject: [PATCH 1/2] Move the main documentation version to the `root` --- docs/_preview/config/_default/hugo.toml | 29 -------------- docs/content/docs/1/_index.md | 37 ------------------ docs/content/docs/_index.md | 37 +++++++++++++++++- .../docs/{1 => }/client-libs/_index.md | 0 docs/content/docs/{1 => }/client-libs/dart.md | 0 docs/content/docs/{1 => }/client-libs/js.md | 0 docs/content/docs/{1 => }/examples/_index.md | 0 docs/content/docs/{1 => }/guides/_index.md | 0 docs/content/docs/{1 => }/guides/gradle.md | 0 .../docs/{1 => }/guides/integration.md | 0 .../content/docs/{1 => }/guides/rejections.md | 0 .../docs/{1 => }/guides/start-new-project.md | 0 .../content/docs/{1 => }/guides/validation.md | 0 .../docs/{1 => }/introduction/_index.md | 0 .../docs/{1 => }/introduction/architecture.md | 0 .../docs/{1 => }/introduction/concepts.md | 0 .../diagrams/Spine-Architecture-Diagram.pdf | Bin .../{1 => }/introduction/diagrams/_index.md | 0 ...pine-architecture-diagram-full-screen.html | 0 .../diagrams/spine-architecture-diagram.svg | 0 .../introduction/naming-conventions.md | 0 .../docs/{1 => }/introduction/prior-art.md | 0 .../{1 => }/introduction/project-structure.md | 0 .../docs/{1 => }/introduction/rules.md | 0 .../docs/{1 => }/quick-start/_index.md | 0 docs/content/docs/{1 => }/reference/index.md | 0 docs/content/docs/{1 => }/resources/_index.md | 0 docs/content/docs/{1 => }/resources/blogs.md | 0 docs/content/docs/{1 => }/resources/books.md | 0 .../docs/{1 => }/resources/communities.md | 0 .../docs/{1 => }/resources/libraries.md | 0 docs/content/docs/{1 => }/resources/people.md | 0 docs/content/docs/{1 => }/resources/sites.md | 0 docs/data/versions.yml | 2 +- 34 files changed, 36 insertions(+), 69 deletions(-) delete mode 100644 docs/content/docs/1/_index.md rename docs/content/docs/{1 => }/client-libs/_index.md (100%) rename docs/content/docs/{1 => }/client-libs/dart.md (100%) rename docs/content/docs/{1 => }/client-libs/js.md (100%) rename docs/content/docs/{1 => }/examples/_index.md (100%) rename docs/content/docs/{1 => }/guides/_index.md (100%) rename docs/content/docs/{1 => }/guides/gradle.md (100%) rename docs/content/docs/{1 => }/guides/integration.md (100%) rename docs/content/docs/{1 => }/guides/rejections.md (100%) rename docs/content/docs/{1 => }/guides/start-new-project.md (100%) rename docs/content/docs/{1 => }/guides/validation.md (100%) rename docs/content/docs/{1 => }/introduction/_index.md (100%) rename docs/content/docs/{1 => }/introduction/architecture.md (100%) rename docs/content/docs/{1 => }/introduction/concepts.md (100%) rename docs/content/docs/{1 => }/introduction/diagrams/Spine-Architecture-Diagram.pdf (100%) rename docs/content/docs/{1 => }/introduction/diagrams/_index.md (100%) rename docs/content/docs/{1 => }/introduction/diagrams/spine-architecture-diagram-full-screen.html (100%) rename docs/content/docs/{1 => }/introduction/diagrams/spine-architecture-diagram.svg (100%) rename docs/content/docs/{1 => }/introduction/naming-conventions.md (100%) rename docs/content/docs/{1 => }/introduction/prior-art.md (100%) rename docs/content/docs/{1 => }/introduction/project-structure.md (100%) rename docs/content/docs/{1 => }/introduction/rules.md (100%) rename docs/content/docs/{1 => }/quick-start/_index.md (100%) rename docs/content/docs/{1 => }/reference/index.md (100%) rename docs/content/docs/{1 => }/resources/_index.md (100%) rename docs/content/docs/{1 => }/resources/blogs.md (100%) rename docs/content/docs/{1 => }/resources/books.md (100%) rename docs/content/docs/{1 => }/resources/communities.md (100%) rename docs/content/docs/{1 => }/resources/libraries.md (100%) rename docs/content/docs/{1 => }/resources/people.md (100%) rename docs/content/docs/{1 => }/resources/sites.md (100%) diff --git a/docs/_preview/config/_default/hugo.toml b/docs/_preview/config/_default/hugo.toml index b636957..a4fa617 100644 --- a/docs/_preview/config/_default/hugo.toml +++ b/docs/_preview/config/_default/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/1}' - kind = 'section' -[[cascade]] - [cascade.params] - url = 'docs/:sections[2:]/' - [cascade.target] - # The path to the current main version. - path = '{/docs/1/**}' - kind = 'section' -[[cascade]] - [cascade.params] - url = 'docs/:sections[2:]/:contentbasename/' - [cascade.target] - # The path to the current main version. - path = '{/docs/1/**}' - kind = 'page' diff --git a/docs/content/docs/1/_index.md b/docs/content/docs/1/_index.md deleted file mode 100644 index f958bd7..0000000 --- a/docs/content/docs/1/_index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Documentation -headline: Documentation ---- - -# Welcome - -{{% note-block class="lead" %}} -Welcome to the Spine developer documentation. This page gives -the overview of the documentation sections. -{{% /note-block %}} - -## [Quick Start](docs/quick-start/) -In this section you can learn what it's like to develop with Spine by going -through the code of the [Hello World]({{% get-site-data "repositories.examples" %}}/hello/) -example. - -## [Introduction](docs/introduction/) -This section gives an overview of the development process, the architecture of -the Spine-based application, information on DDD concepts implemented by the -framework and how framework users deal with them. - -## [Guides](docs/guides/validation) -This section provides detailed instructions on the framework use. - -## [Client Libraries](docs/client-libs/) -This section provides language-specific guides for building client-side applications. - -## [API Reference](docs/reference/) -This sections provides links to the generated documentation. - -## [Examples](docs/examples/) -This page is the entry point for learning from the code of -the [example applications]({{% get-site-data "repositories.examples" %}}). - -## [DDD Resources](docs/resources/) -A brief selection of learning materials we recommend to the colleagues in DDD. diff --git a/docs/content/docs/_index.md b/docs/content/docs/_index.md index 0b15626..f958bd7 100644 --- a/docs/content/docs/_index.md +++ b/docs/content/docs/_index.md @@ -1,4 +1,37 @@ --- -build: - render: never +title: Documentation +headline: Documentation --- + +# Welcome + +{{% note-block class="lead" %}} +Welcome to the Spine developer documentation. This page gives +the overview of the documentation sections. +{{% /note-block %}} + +## [Quick Start](docs/quick-start/) +In this section you can learn what it's like to develop with Spine by going +through the code of the [Hello World]({{% get-site-data "repositories.examples" %}}/hello/) +example. + +## [Introduction](docs/introduction/) +This section gives an overview of the development process, the architecture of +the Spine-based application, information on DDD concepts implemented by the +framework and how framework users deal with them. + +## [Guides](docs/guides/validation) +This section provides detailed instructions on the framework use. + +## [Client Libraries](docs/client-libs/) +This section provides language-specific guides for building client-side applications. + +## [API Reference](docs/reference/) +This sections provides links to the generated documentation. + +## [Examples](docs/examples/) +This page is the entry point for learning from the code of +the [example applications]({{% get-site-data "repositories.examples" %}}). + +## [DDD Resources](docs/resources/) +A brief selection of learning materials we recommend to the colleagues in DDD. diff --git a/docs/content/docs/1/client-libs/_index.md b/docs/content/docs/client-libs/_index.md similarity index 100% rename from docs/content/docs/1/client-libs/_index.md rename to docs/content/docs/client-libs/_index.md diff --git a/docs/content/docs/1/client-libs/dart.md b/docs/content/docs/client-libs/dart.md similarity index 100% rename from docs/content/docs/1/client-libs/dart.md rename to docs/content/docs/client-libs/dart.md diff --git a/docs/content/docs/1/client-libs/js.md b/docs/content/docs/client-libs/js.md similarity index 100% rename from docs/content/docs/1/client-libs/js.md rename to docs/content/docs/client-libs/js.md diff --git a/docs/content/docs/1/examples/_index.md b/docs/content/docs/examples/_index.md similarity index 100% rename from docs/content/docs/1/examples/_index.md rename to docs/content/docs/examples/_index.md diff --git a/docs/content/docs/1/guides/_index.md b/docs/content/docs/guides/_index.md similarity index 100% rename from docs/content/docs/1/guides/_index.md rename to docs/content/docs/guides/_index.md diff --git a/docs/content/docs/1/guides/gradle.md b/docs/content/docs/guides/gradle.md similarity index 100% rename from docs/content/docs/1/guides/gradle.md rename to docs/content/docs/guides/gradle.md diff --git a/docs/content/docs/1/guides/integration.md b/docs/content/docs/guides/integration.md similarity index 100% rename from docs/content/docs/1/guides/integration.md rename to docs/content/docs/guides/integration.md diff --git a/docs/content/docs/1/guides/rejections.md b/docs/content/docs/guides/rejections.md similarity index 100% rename from docs/content/docs/1/guides/rejections.md rename to docs/content/docs/guides/rejections.md diff --git a/docs/content/docs/1/guides/start-new-project.md b/docs/content/docs/guides/start-new-project.md similarity index 100% rename from docs/content/docs/1/guides/start-new-project.md rename to docs/content/docs/guides/start-new-project.md diff --git a/docs/content/docs/1/guides/validation.md b/docs/content/docs/guides/validation.md similarity index 100% rename from docs/content/docs/1/guides/validation.md rename to docs/content/docs/guides/validation.md diff --git a/docs/content/docs/1/introduction/_index.md b/docs/content/docs/introduction/_index.md similarity index 100% rename from docs/content/docs/1/introduction/_index.md rename to docs/content/docs/introduction/_index.md diff --git a/docs/content/docs/1/introduction/architecture.md b/docs/content/docs/introduction/architecture.md similarity index 100% rename from docs/content/docs/1/introduction/architecture.md rename to docs/content/docs/introduction/architecture.md diff --git a/docs/content/docs/1/introduction/concepts.md b/docs/content/docs/introduction/concepts.md similarity index 100% rename from docs/content/docs/1/introduction/concepts.md rename to docs/content/docs/introduction/concepts.md diff --git a/docs/content/docs/1/introduction/diagrams/Spine-Architecture-Diagram.pdf b/docs/content/docs/introduction/diagrams/Spine-Architecture-Diagram.pdf similarity index 100% rename from docs/content/docs/1/introduction/diagrams/Spine-Architecture-Diagram.pdf rename to docs/content/docs/introduction/diagrams/Spine-Architecture-Diagram.pdf diff --git a/docs/content/docs/1/introduction/diagrams/_index.md b/docs/content/docs/introduction/diagrams/_index.md similarity index 100% rename from docs/content/docs/1/introduction/diagrams/_index.md rename to docs/content/docs/introduction/diagrams/_index.md diff --git a/docs/content/docs/1/introduction/diagrams/spine-architecture-diagram-full-screen.html b/docs/content/docs/introduction/diagrams/spine-architecture-diagram-full-screen.html similarity index 100% rename from docs/content/docs/1/introduction/diagrams/spine-architecture-diagram-full-screen.html rename to docs/content/docs/introduction/diagrams/spine-architecture-diagram-full-screen.html diff --git a/docs/content/docs/1/introduction/diagrams/spine-architecture-diagram.svg b/docs/content/docs/introduction/diagrams/spine-architecture-diagram.svg similarity index 100% rename from docs/content/docs/1/introduction/diagrams/spine-architecture-diagram.svg rename to docs/content/docs/introduction/diagrams/spine-architecture-diagram.svg diff --git a/docs/content/docs/1/introduction/naming-conventions.md b/docs/content/docs/introduction/naming-conventions.md similarity index 100% rename from docs/content/docs/1/introduction/naming-conventions.md rename to docs/content/docs/introduction/naming-conventions.md diff --git a/docs/content/docs/1/introduction/prior-art.md b/docs/content/docs/introduction/prior-art.md similarity index 100% rename from docs/content/docs/1/introduction/prior-art.md rename to docs/content/docs/introduction/prior-art.md diff --git a/docs/content/docs/1/introduction/project-structure.md b/docs/content/docs/introduction/project-structure.md similarity index 100% rename from docs/content/docs/1/introduction/project-structure.md rename to docs/content/docs/introduction/project-structure.md diff --git a/docs/content/docs/1/introduction/rules.md b/docs/content/docs/introduction/rules.md similarity index 100% rename from docs/content/docs/1/introduction/rules.md rename to docs/content/docs/introduction/rules.md diff --git a/docs/content/docs/1/quick-start/_index.md b/docs/content/docs/quick-start/_index.md similarity index 100% rename from docs/content/docs/1/quick-start/_index.md rename to docs/content/docs/quick-start/_index.md diff --git a/docs/content/docs/1/reference/index.md b/docs/content/docs/reference/index.md similarity index 100% rename from docs/content/docs/1/reference/index.md rename to docs/content/docs/reference/index.md diff --git a/docs/content/docs/1/resources/_index.md b/docs/content/docs/resources/_index.md similarity index 100% rename from docs/content/docs/1/resources/_index.md rename to docs/content/docs/resources/_index.md diff --git a/docs/content/docs/1/resources/blogs.md b/docs/content/docs/resources/blogs.md similarity index 100% rename from docs/content/docs/1/resources/blogs.md rename to docs/content/docs/resources/blogs.md diff --git a/docs/content/docs/1/resources/books.md b/docs/content/docs/resources/books.md similarity index 100% rename from docs/content/docs/1/resources/books.md rename to docs/content/docs/resources/books.md diff --git a/docs/content/docs/1/resources/communities.md b/docs/content/docs/resources/communities.md similarity index 100% rename from docs/content/docs/1/resources/communities.md rename to docs/content/docs/resources/communities.md diff --git a/docs/content/docs/1/resources/libraries.md b/docs/content/docs/resources/libraries.md similarity index 100% rename from docs/content/docs/1/resources/libraries.md rename to docs/content/docs/resources/libraries.md diff --git a/docs/content/docs/1/resources/people.md b/docs/content/docs/resources/people.md similarity index 100% rename from docs/content/docs/1/resources/people.md rename to docs/content/docs/resources/people.md diff --git a/docs/content/docs/1/resources/sites.md b/docs/content/docs/resources/sites.md similarity index 100% rename from docs/content/docs/1/resources/sites.md rename to docs/content/docs/resources/sites.md diff --git a/docs/data/versions.yml b/docs/data/versions.yml index 1b7da3a..ff5f941 100644 --- a/docs/data/versions.yml +++ b/docs/data/versions.yml @@ -1,7 +1,7 @@ docs: - version_id: "1" label: 1.9.0 - content_path: docs/1 + content_path: docs route_url: docs is_main: true switcher: From 0d3ad9d7c91fab9ae0ea480212d96c7438bb103e Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Thu, 12 Feb 2026 15:30:45 +0100 Subject: [PATCH 2/2] Move the default Hugo config to the root --- docs/_preview/{config/_default => }/hugo.toml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/_preview/{config/_default => }/hugo.toml (100%) diff --git a/docs/_preview/config/_default/hugo.toml b/docs/_preview/hugo.toml similarity index 100% rename from docs/_preview/config/_default/hugo.toml rename to docs/_preview/hugo.toml