From 9a7d9f6c1149879f8fc9deb191ff36610affb70d Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Mon, 2 Feb 2026 13:03:51 +0100 Subject: [PATCH 1/5] Move examples and samples under `docs/_code` --- .gitmodules | 20 +++++++++--------- {_code => docs/_code}/examples/airport | 0 {_code => docs/_code}/examples/blog | 0 {_code => docs/_code}/examples/hello | 0 {_code => docs/_code}/examples/kanban | 0 {_code => docs/_code}/examples/todo-list | 0 {_code => docs/_code}/samples/build.gradle | 0 .../samples/gradle/wrapper/gradle-wrapper.jar | Bin .../gradle/wrapper/gradle-wrapper.properties | 0 {_code => docs/_code}/samples/gradlew | 0 {_code => docs/_code}/samples/gradlew.bat | 0 {_code => docs/_code}/samples/settings.gradle | 0 .../spine/site/home/server/NanoPmContext.java | 0 .../spine/site/home/server/TaskAggregate.java | 0 .../site/home/server/TaskProjection.java | 0 .../spine/site/home/server/package-info.java | 0 .../src/main/proto/spine/example/events.proto | 0 .../main/proto/spine/site/home/commands.proto | 0 .../main/proto/spine/site/home/events.proto | 0 .../proto/spine/site/home/identifiers.proto | 0 .../src/main/proto/spine/site/home/task.proto | 0 .../io/spine/example/CompiledProtobuf.java | 0 .../site/home/server/TaskCreationTest.java | 0 23 files changed, 10 insertions(+), 10 deletions(-) rename {_code => docs/_code}/examples/airport (100%) rename {_code => docs/_code}/examples/blog (100%) rename {_code => docs/_code}/examples/hello (100%) rename {_code => docs/_code}/examples/kanban (100%) rename {_code => docs/_code}/examples/todo-list (100%) rename {_code => docs/_code}/samples/build.gradle (100%) rename {_code => docs/_code}/samples/gradle/wrapper/gradle-wrapper.jar (100%) rename {_code => docs/_code}/samples/gradle/wrapper/gradle-wrapper.properties (100%) rename {_code => docs/_code}/samples/gradlew (100%) rename {_code => docs/_code}/samples/gradlew.bat (100%) rename {_code => docs/_code}/samples/settings.gradle (100%) rename {_code => docs/_code}/samples/src/main/java/io/spine/site/home/server/NanoPmContext.java (100%) rename {_code => docs/_code}/samples/src/main/java/io/spine/site/home/server/TaskAggregate.java (100%) rename {_code => docs/_code}/samples/src/main/java/io/spine/site/home/server/TaskProjection.java (100%) rename {_code => docs/_code}/samples/src/main/java/io/spine/site/home/server/package-info.java (100%) rename {_code => docs/_code}/samples/src/main/proto/spine/example/events.proto (100%) rename {_code => docs/_code}/samples/src/main/proto/spine/site/home/commands.proto (100%) rename {_code => docs/_code}/samples/src/main/proto/spine/site/home/events.proto (100%) rename {_code => docs/_code}/samples/src/main/proto/spine/site/home/identifiers.proto (100%) rename {_code => docs/_code}/samples/src/main/proto/spine/site/home/task.proto (100%) rename {_code => docs/_code}/samples/src/test/java/io/spine/example/CompiledProtobuf.java (100%) rename {_code => docs/_code}/samples/src/test/java/io/spine/site/home/server/TaskCreationTest.java (100%) diff --git a/.gitmodules b/.gitmodules index 2b93455..2a7d81a 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,15 +1,15 @@ -[submodule "_code/examples/airport"] - path = _code/examples/airport +[submodule "docs/_code/examples/airport"] + path = docs/_code/examples/airport url = https://github.com/spine-examples/airport.git -[submodule "_code/examples/blog"] - path = _code/examples/blog +[submodule "docs/_code/examples/blog"] + path = docs/_code/examples/blog url = https://github.com/spine-examples/blog.git -[submodule "_code/examples/hello"] - path = _code/examples/hello +[submodule "docs/_code/examples/hello"] + path = docs/_code/examples/hello url = https://github.com/spine-examples/hello.git -[submodule "_code/examples/kanban"] - path = _code/examples/kanban +[submodule "docs/_code/examples/kanban"] + path = docs/_code/examples/kanban url = https://github.com/spine-examples/kanban.git -[submodule "_code/examples/todo-list"] - path = _code/examples/todo-list +[submodule "docs/_code/examples/todo-list"] + path = docs/_code/examples/todo-list url = https://github.com/spine-examples/todo-list.git diff --git a/_code/examples/airport b/docs/_code/examples/airport similarity index 100% rename from _code/examples/airport rename to docs/_code/examples/airport diff --git a/_code/examples/blog b/docs/_code/examples/blog similarity index 100% rename from _code/examples/blog rename to docs/_code/examples/blog diff --git a/_code/examples/hello b/docs/_code/examples/hello similarity index 100% rename from _code/examples/hello rename to docs/_code/examples/hello diff --git a/_code/examples/kanban b/docs/_code/examples/kanban similarity index 100% rename from _code/examples/kanban rename to docs/_code/examples/kanban diff --git a/_code/examples/todo-list b/docs/_code/examples/todo-list similarity index 100% rename from _code/examples/todo-list rename to docs/_code/examples/todo-list diff --git a/_code/samples/build.gradle b/docs/_code/samples/build.gradle similarity index 100% rename from _code/samples/build.gradle rename to docs/_code/samples/build.gradle diff --git a/_code/samples/gradle/wrapper/gradle-wrapper.jar b/docs/_code/samples/gradle/wrapper/gradle-wrapper.jar similarity index 100% rename from _code/samples/gradle/wrapper/gradle-wrapper.jar rename to docs/_code/samples/gradle/wrapper/gradle-wrapper.jar diff --git a/_code/samples/gradle/wrapper/gradle-wrapper.properties b/docs/_code/samples/gradle/wrapper/gradle-wrapper.properties similarity index 100% rename from _code/samples/gradle/wrapper/gradle-wrapper.properties rename to docs/_code/samples/gradle/wrapper/gradle-wrapper.properties diff --git a/_code/samples/gradlew b/docs/_code/samples/gradlew similarity index 100% rename from _code/samples/gradlew rename to docs/_code/samples/gradlew diff --git a/_code/samples/gradlew.bat b/docs/_code/samples/gradlew.bat similarity index 100% rename from _code/samples/gradlew.bat rename to docs/_code/samples/gradlew.bat diff --git a/_code/samples/settings.gradle b/docs/_code/samples/settings.gradle similarity index 100% rename from _code/samples/settings.gradle rename to docs/_code/samples/settings.gradle diff --git a/_code/samples/src/main/java/io/spine/site/home/server/NanoPmContext.java b/docs/_code/samples/src/main/java/io/spine/site/home/server/NanoPmContext.java similarity index 100% rename from _code/samples/src/main/java/io/spine/site/home/server/NanoPmContext.java rename to docs/_code/samples/src/main/java/io/spine/site/home/server/NanoPmContext.java diff --git a/_code/samples/src/main/java/io/spine/site/home/server/TaskAggregate.java b/docs/_code/samples/src/main/java/io/spine/site/home/server/TaskAggregate.java similarity index 100% rename from _code/samples/src/main/java/io/spine/site/home/server/TaskAggregate.java rename to docs/_code/samples/src/main/java/io/spine/site/home/server/TaskAggregate.java diff --git a/_code/samples/src/main/java/io/spine/site/home/server/TaskProjection.java b/docs/_code/samples/src/main/java/io/spine/site/home/server/TaskProjection.java similarity index 100% rename from _code/samples/src/main/java/io/spine/site/home/server/TaskProjection.java rename to docs/_code/samples/src/main/java/io/spine/site/home/server/TaskProjection.java diff --git a/_code/samples/src/main/java/io/spine/site/home/server/package-info.java b/docs/_code/samples/src/main/java/io/spine/site/home/server/package-info.java similarity index 100% rename from _code/samples/src/main/java/io/spine/site/home/server/package-info.java rename to docs/_code/samples/src/main/java/io/spine/site/home/server/package-info.java diff --git a/_code/samples/src/main/proto/spine/example/events.proto b/docs/_code/samples/src/main/proto/spine/example/events.proto similarity index 100% rename from _code/samples/src/main/proto/spine/example/events.proto rename to docs/_code/samples/src/main/proto/spine/example/events.proto diff --git a/_code/samples/src/main/proto/spine/site/home/commands.proto b/docs/_code/samples/src/main/proto/spine/site/home/commands.proto similarity index 100% rename from _code/samples/src/main/proto/spine/site/home/commands.proto rename to docs/_code/samples/src/main/proto/spine/site/home/commands.proto diff --git a/_code/samples/src/main/proto/spine/site/home/events.proto b/docs/_code/samples/src/main/proto/spine/site/home/events.proto similarity index 100% rename from _code/samples/src/main/proto/spine/site/home/events.proto rename to docs/_code/samples/src/main/proto/spine/site/home/events.proto diff --git a/_code/samples/src/main/proto/spine/site/home/identifiers.proto b/docs/_code/samples/src/main/proto/spine/site/home/identifiers.proto similarity index 100% rename from _code/samples/src/main/proto/spine/site/home/identifiers.proto rename to docs/_code/samples/src/main/proto/spine/site/home/identifiers.proto diff --git a/_code/samples/src/main/proto/spine/site/home/task.proto b/docs/_code/samples/src/main/proto/spine/site/home/task.proto similarity index 100% rename from _code/samples/src/main/proto/spine/site/home/task.proto rename to docs/_code/samples/src/main/proto/spine/site/home/task.proto diff --git a/_code/samples/src/test/java/io/spine/example/CompiledProtobuf.java b/docs/_code/samples/src/test/java/io/spine/example/CompiledProtobuf.java similarity index 100% rename from _code/samples/src/test/java/io/spine/example/CompiledProtobuf.java rename to docs/_code/samples/src/test/java/io/spine/example/CompiledProtobuf.java diff --git a/_code/samples/src/test/java/io/spine/site/home/server/TaskCreationTest.java b/docs/_code/samples/src/test/java/io/spine/site/home/server/TaskCreationTest.java similarity index 100% rename from _code/samples/src/test/java/io/spine/site/home/server/TaskCreationTest.java rename to docs/_code/samples/src/test/java/io/spine/site/home/server/TaskCreationTest.java From 6ea835a0fbb9ae86a2836b7bafe92451617e80a9 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Mon, 2 Feb 2026 13:12:27 +0100 Subject: [PATCH 2/5] Move the `embed-code` binaries into `docs/_bin` and the appropriate config file into the `_settings` --- _code/EMBEDDING.md => EMBEDDING.md | 26 +++++++++---------- _code/config-v1.yml | 5 ---- {_code => docs/_bin}/embed-code-macos | Bin {_code => docs/_bin}/embed-code-macos-x86_64 | Bin {_code => docs/_bin}/embed-code-ubuntu | Bin docs/_settings/v1.embed-code.yml | 5 ++++ settings.gradle.kts | 6 ++--- 7 files changed, 21 insertions(+), 21 deletions(-) rename _code/EMBEDDING.md => EMBEDDING.md (82%) delete mode 100644 _code/config-v1.yml rename {_code => docs/_bin}/embed-code-macos (100%) rename {_code => docs/_bin}/embed-code-macos-x86_64 (100%) rename {_code => docs/_bin}/embed-code-ubuntu (100%) create mode 100644 docs/_settings/v1.embed-code.yml diff --git a/_code/EMBEDDING.md b/EMBEDDING.md similarity index 82% rename from _code/EMBEDDING.md rename to EMBEDDING.md index 6d1c46e..d0e9dee 100644 --- a/_code/EMBEDDING.md +++ b/EMBEDDING.md @@ -16,11 +16,11 @@ available as a binary executable written in Go. 1. Open [embed-code][embed-code-repo] repository. 2. Switch to the `embed-code-go` branch. 3. Go to the `embed-code-go/bin` and download an executable suitable for you OS. -4. Put it in the `_code` directory of this repository. +4. Put it in the `docs/_bin` directory of this repository. ### Download code snippets -The `_code` directory contains the source code, which is embedded into the pages +The `docs/_code` directory contains the source code, which is embedded into the pages of the spine.io documentation: * `examples` — contains examples selected from the repositories under `spine-examples` @@ -35,7 +35,7 @@ git submodule update --remote ### Config files -As for now, there is the `_code/config-v1.yml` config file for Spine v1. +As for now, there is the `docs/_settings/v1.embed-code.yml` config file for Spine v1. ## Usage patterns @@ -53,13 +53,13 @@ to the documentation files using the tool. The most important points here are: 1. Update the snippet in the appropriate repository. 2. Make sure it builds successfully. 3. Go to the `SpineEventEngine/documentation` project. -4. Navigate to the `_code` directory. +4. Navigate to the `docs/_bin` directory. 5. Execute the binary based on your operating system and architecture: `./embed-code- -config-path="config-of-your-choice.yml" -mode="embed"`. For example: ```shell - ./embed-code-macos -config-path="config-v1.yml" -mode="embed" + ./embed-code-macos -config-path="../_settings/v1.embed-code.yml" -mode="embed" ``` ### Adding a new example project @@ -76,29 +76,29 @@ to the documentation files using the tool. The most important points here are: 2. Add the example code as a submodule for this project: ```bash - git submodule add https://github.com/spine-examples/ _code/examples/ + git submodule add https://github.com/spine-examples/ docs/_code/examples/ ``` - Please make sure the new submodule goes under the `_code/examples` directory, as shown in - the command line template above. + Please make sure the new submodule goes under the `docs/_code/examples` directory, + as shown in the command line template above. 3. Include the build of the added project into the [`settings.gradle.kts`](settings.gradle.kts) file. 4. Insert code embedding directives where needed in the `docs/content/` folder. -5. Navigate to the `_code` directory. +5. Navigate to the `docs/_bin` directory. 6. Execute: `./embed-code -config-path="config-of-your-choice.yml" -mode="embed"`. For example: ```shell - ./embed-code-macos -config-path="config-v1.yml" -mode="embed" + ./embed-code-macos -config-path="../_settings/v1.embed-code.yml" -mode="embed" ``` ### Adding a new small piece -1. Add the code under `_code/samples/src` directory. +1. Add the code under `docs/_code/samples/src` directory. 2. Make sure tests for the new code pass. 3. Add the new piece using the [`embed-code` guide][embed-code-readme]. 4. Include the build of the added project into the [`settings.gradle.kts`](settings.gradle.kts) - file `includeBuild("./_code/samples")`. + file `includeBuild("./docs/_code/samples")`. ### How to remove a code snippet? @@ -109,7 +109,7 @@ to the documentation files using the tool. The most important points here are: For example: ```shell - ./embed-code-macos -config-path="config-v1.yml" -mode="check" + ./embed-code-macos -config-path="../_settings/v1.embed-code.yml" -mode="check" ``` ## Troubleshooting diff --git a/_code/config-v1.yml b/_code/config-v1.yml deleted file mode 100644 index 4f7184c..0000000 --- a/_code/config-v1.yml +++ /dev/null @@ -1,5 +0,0 @@ -code-path: "../_code" -docs-path: "../docs/content/docs/1" -embed-mappings: - - code-path: "../_code" - docs-path: "../docs/content/docs/1" diff --git a/_code/embed-code-macos b/docs/_bin/embed-code-macos similarity index 100% rename from _code/embed-code-macos rename to docs/_bin/embed-code-macos diff --git a/_code/embed-code-macos-x86_64 b/docs/_bin/embed-code-macos-x86_64 similarity index 100% rename from _code/embed-code-macos-x86_64 rename to docs/_bin/embed-code-macos-x86_64 diff --git a/_code/embed-code-ubuntu b/docs/_bin/embed-code-ubuntu similarity index 100% rename from _code/embed-code-ubuntu rename to docs/_bin/embed-code-ubuntu diff --git a/docs/_settings/v1.embed-code.yml b/docs/_settings/v1.embed-code.yml new file mode 100644 index 0000000..09c5480 --- /dev/null +++ b/docs/_settings/v1.embed-code.yml @@ -0,0 +1,5 @@ +code-path: "../_code" +docs-path: "../content/docs/1" +embed-mappings: + - code-path: "../_code" + docs-path: "../content/docs/1" diff --git a/settings.gradle.kts b/settings.gradle.kts index 52ac3da..e84e601 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -26,7 +26,7 @@ rootProject.name = "spine-docs" -includeBuild("./_code/samples") +includeBuild("./docs/_code/samples") -includeBuild("./_code/examples/airport") -includeBuild("./_code/examples/hello") +includeBuild("./docs/_code/examples/airport") +includeBuild("./docs/_code/examples/hello") From f7b00074e2896d193519685d93edd4f9ffb35fa0 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Mon, 2 Feb 2026 13:28:30 +0100 Subject: [PATCH 3/5] Move `_script` under `docs` --- build.gradle.kts | 10 +++++----- {_script => docs/_script}/check-samples | 6 +++--- {_script => docs/_script}/embed-code | 8 ++++---- {_script => docs/_script}/hugo-build | 0 {_script => docs/_script}/hugo-serve | 0 {_script => docs/_script}/install-dependencies | 0 6 files changed, 12 insertions(+), 12 deletions(-) rename {_script => docs/_script}/check-samples (93%) rename {_script => docs/_script}/embed-code (89%) rename {_script => docs/_script}/hugo-build (100%) rename {_script => docs/_script}/hugo-serve (100%) rename {_script => docs/_script}/install-dependencies (100%) diff --git a/build.gradle.kts b/build.gradle.kts index b0051de..1845d05 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -29,7 +29,7 @@ */ task("runSite") { dependsOn("installDependencies") - commandLine("./_script/hugo-serve") + commandLine("./docs/_script/hugo-serve") } /** @@ -37,28 +37,28 @@ task("runSite") { */ task("buildSite") { dependsOn("installDependencies") - commandLine("./_script/hugo-build") + commandLine("./docs/_script/hugo-build") } /** * Installs the Node.js dependencies required for building the site. */ task("installDependencies") { - commandLine("./_script/install-dependencies") + commandLine("./docs/_script/install-dependencies") } /** * Embeds the code samples into pages of the site. */ task("embedCode") { - commandLine("./_script/embed-code") + commandLine("./docs/_script/embed-code") } /** * Verifies that the source code samples embedded into the pages are up-to-date. */ task("checkSamples") { - commandLine("./_script/check-samples") + commandLine("./docs/_script/check-samples") } /** diff --git a/_script/check-samples b/docs/_script/check-samples similarity index 93% rename from _script/check-samples rename to docs/_script/check-samples index c724ed1..9b48ce1 100755 --- a/_script/check-samples +++ b/docs/_script/check-samples @@ -39,8 +39,8 @@ elif [ -f ${BASH_RC} ]; then . ${BASH_RC} fi -# Navigate to the folder with samples. -cd _code +# Navigate to the folder with embed-code binaries. +cd docs/_bin # Use the Ubuntu binary for GitHub Actions and macOS binary in other cases. if [ "$GITHUB_ACTIONS" = "true" ]; then @@ -52,4 +52,4 @@ else fi # Check code samples. -"$TOOL" -config-path="config-v1.yml" -mode="check" +"$TOOL" -config-path="../_settings/v1.embed-code.yml" -mode="check" diff --git a/_script/embed-code b/docs/_script/embed-code similarity index 89% rename from _script/embed-code rename to docs/_script/embed-code index 67de7b1..eeb4d0d 100755 --- a/_script/embed-code +++ b/docs/_script/embed-code @@ -37,11 +37,11 @@ elif [ -f ${BASH_RC} ]; then . ${BASH_RC} fi -# Ensure `_code` files are fetched. +# Ensure `docs/_code` files are fetched. git submodule update --remote --merge --recursive -# Navigate to the folder with samples. -cd _code +# Navigate to the folder with embed-code binaries. +cd docs/_bin # Update code samples. -./embed-code-macos -config-path="config-v1.yml" -mode="embed" +./embed-code-macos -config-path="../_settings/v1.embed-code.yml" -mode="embed" diff --git a/_script/hugo-build b/docs/_script/hugo-build similarity index 100% rename from _script/hugo-build rename to docs/_script/hugo-build diff --git a/_script/hugo-serve b/docs/_script/hugo-serve similarity index 100% rename from _script/hugo-serve rename to docs/_script/hugo-serve diff --git a/_script/install-dependencies b/docs/_script/install-dependencies similarity index 100% rename from _script/install-dependencies rename to docs/_script/install-dependencies From 7f6eb0adc3fb7cceabec77799b085d7c4a9d0ad0 Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Mon, 2 Feb 2026 13:41:52 +0100 Subject: [PATCH 4/5] Move `_site` under `docs` --- .gitignore | 6 +++--- docs/_script/hugo-build | 2 +- docs/_script/hugo-serve | 2 +- docs/_script/install-dependencies | 2 +- {site => docs/_site}/.browserslistrc | 0 {site => docs/_site}/assets/scss/docs/_home.scss | 0 {site => docs/_site}/assets/scss/docs/_layout.scss | 0 {site => docs/_site}/assets/scss/main.scss | 0 {site => docs/_site}/config/_default/hugo.toml | 2 +- {site => docs/_site}/content/_index.md | 0 {site => docs/_site}/go.mod | 0 {site => docs/_site}/go.sum | 0 {site => docs/_site}/layouts/_default/baseof.html | 0 {site => docs/_site}/layouts/_default/page.html | 0 {site => docs/_site}/layouts/_default/section.html | 0 {site => docs/_site}/layouts/_partials/head/head.html | 0 {site => docs/_site}/layouts/_partials/head/stylesheet.html | 0 {site => docs/_site}/layouts/_partials/head/title.html | 0 .../_site}/layouts/_partials/scripts/body-scripts.html | 0 .../_site}/layouts/_partials/scripts/head-scripts.html | 0 {site => docs/_site}/layouts/index.html | 0 {site => docs/_site}/package-lock.json | 0 {site => docs/_site}/package.json | 0 {site => docs/_site}/postcss.config.js | 0 24 files changed, 7 insertions(+), 7 deletions(-) rename {site => docs/_site}/.browserslistrc (100%) rename {site => docs/_site}/assets/scss/docs/_home.scss (100%) rename {site => docs/_site}/assets/scss/docs/_layout.scss (100%) rename {site => docs/_site}/assets/scss/main.scss (100%) rename {site => docs/_site}/config/_default/hugo.toml (98%) rename {site => docs/_site}/content/_index.md (100%) rename {site => docs/_site}/go.mod (100%) rename {site => docs/_site}/go.sum (100%) rename {site => docs/_site}/layouts/_default/baseof.html (100%) rename {site => docs/_site}/layouts/_default/page.html (100%) rename {site => docs/_site}/layouts/_default/section.html (100%) rename {site => docs/_site}/layouts/_partials/head/head.html (100%) rename {site => docs/_site}/layouts/_partials/head/stylesheet.html (100%) rename {site => docs/_site}/layouts/_partials/head/title.html (100%) rename {site => docs/_site}/layouts/_partials/scripts/body-scripts.html (100%) rename {site => docs/_site}/layouts/_partials/scripts/head-scripts.html (100%) rename {site => docs/_site}/layouts/index.html (100%) rename {site => docs/_site}/package-lock.json (100%) rename {site => docs/_site}/package.json (100%) rename {site => docs/_site}/postcss.config.js (100%) diff --git a/.gitignore b/.gitignore index c766456..36c4d07 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,15 @@ # Hugo cache files -/site/resources +docs/_site/resources public # Cache folder for Hugo Modules -/site/_vendor +docs/_site/_vendor # Node modules node_modules # Used to control concurrency between multiple Hugo instances -/site/.hugo_build.lock +docs/_site/.hugo_build.lock # Needed for navigation/intellisense help inside code editors jsconfig.json diff --git a/docs/_script/hugo-build b/docs/_script/hugo-build index cc35453..1694e90 100755 --- a/docs/_script/hugo-build +++ b/docs/_script/hugo-build @@ -37,5 +37,5 @@ elif [ -f ${BASH_RC} ]; then . ${BASH_RC} fi -cd site +cd docs/_site hugo diff --git a/docs/_script/hugo-serve b/docs/_script/hugo-serve index 0180823..b450ca6 100755 --- a/docs/_script/hugo-serve +++ b/docs/_script/hugo-serve @@ -37,5 +37,5 @@ elif [ -f ${BASH_RC} ]; then . ${BASH_RC} fi -cd site +cd docs/_site hugo server diff --git a/docs/_script/install-dependencies b/docs/_script/install-dependencies index d35feb1..e93b86d 100755 --- a/docs/_script/install-dependencies +++ b/docs/_script/install-dependencies @@ -38,5 +38,5 @@ elif [ -f ${BASH_RC} ]; then . ${BASH_RC} fi -cd site +cd docs/_site npm install diff --git a/site/.browserslistrc b/docs/_site/.browserslistrc similarity index 100% rename from site/.browserslistrc rename to docs/_site/.browserslistrc diff --git a/site/assets/scss/docs/_home.scss b/docs/_site/assets/scss/docs/_home.scss similarity index 100% rename from site/assets/scss/docs/_home.scss rename to docs/_site/assets/scss/docs/_home.scss diff --git a/site/assets/scss/docs/_layout.scss b/docs/_site/assets/scss/docs/_layout.scss similarity index 100% rename from site/assets/scss/docs/_layout.scss rename to docs/_site/assets/scss/docs/_layout.scss diff --git a/site/assets/scss/main.scss b/docs/_site/assets/scss/main.scss similarity index 100% rename from site/assets/scss/main.scss rename to docs/_site/assets/scss/main.scss diff --git a/site/config/_default/hugo.toml b/docs/_site/config/_default/hugo.toml similarity index 98% rename from site/config/_default/hugo.toml rename to docs/_site/config/_default/hugo.toml index fa0944e..6fa5698 100644 --- a/site/config/_default/hugo.toml +++ b/docs/_site/config/_default/hugo.toml @@ -6,7 +6,7 @@ disableKinds = ['taxonomy', 'term'] [module] # First theme has higher priority than later ones. [[module.imports]] - path = '../../docs' + path = '../..' [[module.imports]] path = 'github.com/TeamDev-Ltd/site-commons' diff --git a/site/content/_index.md b/docs/_site/content/_index.md similarity index 100% rename from site/content/_index.md rename to docs/_site/content/_index.md diff --git a/site/go.mod b/docs/_site/go.mod similarity index 100% rename from site/go.mod rename to docs/_site/go.mod diff --git a/site/go.sum b/docs/_site/go.sum similarity index 100% rename from site/go.sum rename to docs/_site/go.sum diff --git a/site/layouts/_default/baseof.html b/docs/_site/layouts/_default/baseof.html similarity index 100% rename from site/layouts/_default/baseof.html rename to docs/_site/layouts/_default/baseof.html diff --git a/site/layouts/_default/page.html b/docs/_site/layouts/_default/page.html similarity index 100% rename from site/layouts/_default/page.html rename to docs/_site/layouts/_default/page.html diff --git a/site/layouts/_default/section.html b/docs/_site/layouts/_default/section.html similarity index 100% rename from site/layouts/_default/section.html rename to docs/_site/layouts/_default/section.html diff --git a/site/layouts/_partials/head/head.html b/docs/_site/layouts/_partials/head/head.html similarity index 100% rename from site/layouts/_partials/head/head.html rename to docs/_site/layouts/_partials/head/head.html diff --git a/site/layouts/_partials/head/stylesheet.html b/docs/_site/layouts/_partials/head/stylesheet.html similarity index 100% rename from site/layouts/_partials/head/stylesheet.html rename to docs/_site/layouts/_partials/head/stylesheet.html diff --git a/site/layouts/_partials/head/title.html b/docs/_site/layouts/_partials/head/title.html similarity index 100% rename from site/layouts/_partials/head/title.html rename to docs/_site/layouts/_partials/head/title.html diff --git a/site/layouts/_partials/scripts/body-scripts.html b/docs/_site/layouts/_partials/scripts/body-scripts.html similarity index 100% rename from site/layouts/_partials/scripts/body-scripts.html rename to docs/_site/layouts/_partials/scripts/body-scripts.html diff --git a/site/layouts/_partials/scripts/head-scripts.html b/docs/_site/layouts/_partials/scripts/head-scripts.html similarity index 100% rename from site/layouts/_partials/scripts/head-scripts.html rename to docs/_site/layouts/_partials/scripts/head-scripts.html diff --git a/site/layouts/index.html b/docs/_site/layouts/index.html similarity index 100% rename from site/layouts/index.html rename to docs/_site/layouts/index.html diff --git a/site/package-lock.json b/docs/_site/package-lock.json similarity index 100% rename from site/package-lock.json rename to docs/_site/package-lock.json diff --git a/site/package.json b/docs/_site/package.json similarity index 100% rename from site/package.json rename to docs/_site/package.json diff --git a/site/postcss.config.js b/docs/_site/postcss.config.js similarity index 100% rename from site/postcss.config.js rename to docs/_site/postcss.config.js From 47885a23d6b2a77cc5d8f349fc808f7f349ef14c Mon Sep 17 00:00:00 2001 From: "julia.evseeva" Date: Mon, 2 Feb 2026 13:44:39 +0100 Subject: [PATCH 5/5] Update `README.md` --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4d6a5be..e28fbda 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The project has two directories: * `docs` – contains the documentation files along with all the necessary JS and CSS files. This directory will be added to `SpineEventEngine/SpineEventEngine.github.io` as a Hugo Module. -* `site` – contains the HTML and CSS files needed only to run the +* `docs/_site` – contains the HTML and CSS files needed only to run the documentation locally. To build and launch the site on the local server: @@ -53,7 +53,7 @@ To build the site without running the server: Another way to run the site locally is to follow these steps: -1. Navigate to the `site` folder. +1. Navigate to the `docs/_site` folder. 2. Start the local server with this command: ```shell @@ -80,7 +80,7 @@ be updated in the main `spine.io` site repository. To get theme updates: -1. Navigate to the `site` directory. +1. Navigate to the `docs/_site` directory. 2. Clean the module cache: ```shell @@ -101,8 +101,8 @@ To get theme updates: The code samples used in the framework documentation are added using the [`embed-code`][embed-code] tool (Go version). -The code resides under the `_code` directory. For instructions on embedding -the code into the pages, please see the [`EMBEDDING.md`](./_code/EMBEDDING.md) file. +The code resides under the `docs/_code` directory. For instructions on embedding +the code into the pages, please see the [`EMBEDDING.md`](EMBEDDING.md) file. Please note that the following part of the script requires an ARM-based Mac. @@ -142,7 +142,7 @@ There are two main import files: Should be imported into the `main.scss` of the `spine.io` site as well. Styles needed only for running the documentation locally are located -in `site/assets/scss`. They will not be available on `spine.io`. +in `docs/_site/assets/scss`. They will not be available on `spine.io`. ## Troubleshooting