1.9 Organise docs folder. (slint-ui#7005)

Move astro files to docs/astro

Author: NigelBreslaw

.github/workflows/build_docs.yaml

@@ -23,7 +23,7 @@ jobs:
             # Allow deprecated warning because we are using nightly and some things might be deprecated in nightly
             # for which the stable alternative is not yet available.
             RUSTFLAGS: -D warnings -W deprecated
-            RUSTDOCFLAGS: --html-in-header=/home/runner/work/slint/slint/docs/src/utils/slint-docs-highlight.html -D warnings -W deprecated --cfg docsrs
+            RUSTDOCFLAGS: --html-in-header=/home/runner/work/slint/slint/docs/astro/src/utils/slint-docs-highlight.html -D warnings -W deprecated --cfg docsrs
             SLINT_NO_QT: 1
             CARGO_INCREMENTAL: false
             RELEASE_INPUT: ${{ inputs.release }}
@@ -88,17 +88,17 @@ jobs:
                   cp -r target/aarch64-linux-android/doc/i_slint_backend_testing/ target/doc/
 
             - name: "Generate Screenshots for Example Snippets"
-              run: cargo run -p slint-docsnapper -- docs/src/content --overwrite
+              run: cargo run -p slint-docsnapper -- docs/astro/src/content --overwrite
             - name: "Install Node dependencies"
               run: pnpm i --frozen-lockfile
 
             - name: "Run lint checks"
-              working-directory: docs
+              working-directory: docs/astro
               continue-on-error: true
               run: pnpm lint
 
             - name: "Run format checks"
-              working-directory: docs
+              working-directory: docs/astro
               continue-on-error: true
               run: pnpm format
             - name: Update URL for sitemap in astro.config.mjs
@@ -109,14 +109,14 @@ jobs:
             - name: "Slint Language Documentation"
               run: cargo xtask slintdocs
             - name: Spellcheck
-              working-directory: docs
+              working-directory: docs/astro
               run: pnpm spellcheck
             # Test docs
             - name: Run Playwright tests
-              working-directory: docs
+              working-directory: docs/astro
               run: pnpm exec playwright test
             - name: Publish Test Summary Results
-              working-directory: docs
+              working-directory: docs/astro
               run: npx github-actions-ctrf playwright-report/ctrf-report.json
 
             - name: "Node docs"
@@ -162,7 +162,7 @@ jobs:
                   path: |
                       target/doc
                       target/cppdocs/html
-                      docs/dist
+                      docs/astro/dist
                       api/node/docs
                       docs/site
             - name: "Check for docs warnings in internal crates"

.github/workflows/nightly_snapshot.yaml

@@ -576,11 +576,11 @@ jobs:
                    RELEASE_INPUT: ${{ github.event.inputs.release }}
               run: |
                   if [ "$RELEASE_INPUT" != "true" ]; then
-                    notes_file=slint-src/docs/src/utils/_templates/nightly-release-notes.md
+                    notes_file=slint-src/docs/nightly-release-notes.md
                     version=nightly
                     download_version=$version
                   else
-                    notes_file=slint-src/docs/src/utils/_templates/release-notes.md
+                    notes_file=slint-src/docs/release-notes.md
                     version=$(echo artifacts/Slint-cpp-*-win64-MSVC.exe | sed -nre 's/^.*-([0-9]+\.[0-9]+\.[0-9]+).*$/\1/p')
                     if [[ -z "$version" ]]; then
                       echo "Version not found"
@@ -591,7 +591,7 @@ jobs:
                     download_version=v$version
                   fi
                   echo "VERSION=$version" >> $GITHUB_OUTPUT
-                  cat $notes_file slint-src/docs/src/utils/_templates/release-artifacts.md > release-notes.md
+                  cat $notes_file slint-src/docs/release-artifacts.md > release-notes.md
                   sed -i -e "s,{version},$version,g" release-notes.md
                   sed -i -e "s,{download_version},$download_version,g" release-notes.md
                   sed -i -e "s,{major_version},$major_version,g" release-notes.md

.gitignore

@@ -9,8 +9,8 @@ node_modules
 /_deps
 .DS_Store
 Pipfile.lock
-/docs/src/content/collections/enums/
-/docs/src/content/collections/structs/
+/docs/astro/src/content/collections/enums/
+/docs/astro/src/content/collections/structs/
 /playwright-report
 
 # Ignore all package-lock.json files

CMakeLists.txt

@@ -40,7 +40,7 @@ if(SLINT_BUILD_EXAMPLES)
     add_subdirectory(demos)
 endif()
 if(SLINT_BUILD_TESTING AND (SLINT_FEATURE_COMPILER OR SLINT_COMPILER))
-    add_subdirectory(docs/src/content/code/)
+    add_subdirectory(docs/astro/src/content/code/)
 endif()
 
 feature_summary(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:")

CONTRIBUTING.md

@@ -14,7 +14,8 @@ path = [
   "**/slint-logo-**.pdf",
   "**/slint-logo-**.png",
   "**/slint-logo-**.svg",
-  "docs/src/content/docs/reference/elements/slint-logo.png",
+  "docs/astro/public/favicon.svg",
+  "docs/astro/src/content/docs/reference/elements/slint-logo.png",
 ]
 precedence = "aggregate"
 SPDX-FileCopyrightText = "Copyright © SixtyFPS GmbH <[email protected]>"
@@ -80,13 +81,13 @@ path = [
   "docs/**/book.toml",
   "docs/**/package.json",
   "docs/public/**.svg",
-  "docs/src/assets/**.svg",
-  "docs/src/assets/**.webp",
-  "docs/src/assets/getting-started/**.webp",
-  "docs/src/content/docs/reference/elements/mini-banner.png",
-  "docs/src/misc/**.json",
-  "docs/src/misc/**.jsonc",
-  "docs/src/utils/_templates/**.md",
+  "docs/astro/src/assets/**.svg",
+  "docs/astro/src/assets/**.webp",
+  "docs/astro/src/assets/getting-started/**.webp",
+  "docs/astro/src/content/docs/reference/elements/mini-banner.png",
+  "docs/astro/src/misc/**.json",
+  "docs/astro/src/misc/**.jsonc",
+  "docs/astro/src/utils/_templates/**.md",
 
   "examples/**.json",
   "examples/**/LC_MESSAGES/**.mo",

README.md

@@ -1,6 +1,6 @@
 {% extends "!base.html" %}
 {% block scripts %}
 {{ super() }}
-{% include "../../../../docs/src/utils/slint-docs-preview.html" %}
-{% include "../../../../docs/src/utils/slint-docs-highlight.html" %}
+{% include "../../../../docs/astro/src/utils/slint-docs-preview.html" %}
+{% include "../../../../docs/astro/src/utils/slint-docs-highlight.html" %}
 {% endblock %}

REUSE.toml

@@ -210,8 +210,8 @@ i-slint-backend-qt = { workspace = true, features = [ "enable" ], optional = tru
 [package.metadata.docs.rs]
 rustdoc-args = [
   # "--html-in-header",
-  # "docs/src/utils/slint-docs-preview.html",
+  # "docs/astro/src/utils/slint-docs-preview.html",
   "--html-in-header",
-  "docs/src/utils/slint-docs-highlight.html",
+  "docs/astro/src/utils/slint-docs-highlight.html",
 ]
 features = ["document-features", "log", "gettext", "renderer-software", "renderer-femtovg", "raw-window-handle-06"]

api/cpp/docs/_templates/base.html

@@ -1,5 +1,5 @@
 {
-    "extends": ["../biome.json"],
+    "extends": ["../../biome.json"],
     "formatter": {
         "ignore": ["archive/**", ".astro"]
     },

api/node/README.md

@@ -18,7 +18,7 @@ fn main() {
         println!("cargo:rustc-cfg=no_qt");
         println!(
             "cargo:warning=Could not find a Qt installation. The Qt backend will not be functional. \
-            See https://github.com/slint-ui/slint/blob/master/docs/src/utils/_templates/install_qt.md for more info"
+            See https://github.com/slint-ui/slint/blob/master/docs/install_qt.md for more info"
         );
         println!("cargo:warning=    {}", std::env::var("DEP_QT_ERROR_MESSAGE").unwrap());
         return;
@@ -28,7 +28,7 @@ fn main() {
         println!("cargo:rustc-cfg=no_qt");
         println!(
             "cargo:warning=Qt {} is not supported, you need at least Qt 5.15. The Qt backend will not be functional. \
-             See https://github.com/slint-ui/slint/blob/master/docs/src/utils/_templates/install_qt.md for more info",
+             See https://github.com/slint-ui/slint/blob/master/docs/install_qt.md for more info",
             qt_version
         );
         return;

api/node/cover.md

@@ -10,5 +10,4 @@ packages:
   - "examples/carousel/node"
   - "examples/todo/node"
   - "examples/memory"
-  - "docs/editor"
-  - "docs"
+  - "docs/astro"

api/rs/slint/Cargo.toml

@@ -436,7 +436,6 @@ lazy_static! {
         ("^editors/tree-sitter-slint/corpus/", LicenseLocation::NoLicense), // liberal license
         ("^api/cpp/docs/_static/", LicenseLocation::NoLicense),
         ("^api/cpp/docs/_templates/", LicenseLocation::NoLicense),
-        ("^docs/src/utils/_templates/", LicenseLocation::NoLicense),
         ("^docs/quickstart/theme/", LicenseLocation::NoLicense),
         ("^editors/tree-sitter-slint/queries/", LicenseLocation::NoLicense), // liberal license
 

demos/README.md

@@ -15,7 +15,7 @@ pub fn generate() -> Result<(), Box<dyn std::error::Error>> {
 
     let root = super::root_dir();
 
-    let docs_source_dir = root.join("docs");
+    let docs_source_dir = root.join("docs/astro");
 
     {
         let sh = Shell::new()?;
@@ -32,7 +32,7 @@ fn write_individual_enum_files(
     root_dir: &Path,
     enums: &std::collections::BTreeMap<String, EnumDoc>,
 ) -> Result<(), Box<dyn std::error::Error>> {
-    let enums_dir = root_dir.join("docs/src/content/collections/enums");
+    let enums_dir = root_dir.join("docs/astro/src/content/collections/enums");
     create_dir_all(&enums_dir).context(format!(
         "Failed to create folder holding individual enum doc files {enums_dir:?}"
     ))?;
@@ -224,7 +224,7 @@ fn write_individual_struct_files(
     root_dir: &Path,
     structs: std::collections::BTreeMap<String, StructDoc>,
 ) -> Result<(), Box<dyn std::error::Error>> {
-    let structs_dir = root_dir.join("docs/src/content/collections/structs");
+    let structs_dir = root_dir.join("docs/astro/src/content/collections/structs");
     create_dir_all(&structs_dir).context(format!(
         "Failed to create folder holding individual structs doc files {structs_dir:?}"
     ))?;