diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml index ebeaea52630..791122db36d 100644 --- a/.github/workflows/build_docs.yaml +++ b/.github/workflows/build_docs.yaml @@ -89,15 +89,15 @@ jobs: cargo doc -p i-slint-backend-android-activity -p i-slint-backend-winit --no-deps --target aarch64-linux-android --features=i-slint-backend-android-activity/native-activity,i-slint-backend-winit/renderer-femtovg cp -r target/aarch64-linux-android/doc/i_slint_backend_android_activity/ target/doc/ cp -r target/aarch64-linux-android/doc/i_slint_backend_winit/ target/doc/ - - name: "Rust Tutorial Docs" + - name: "Rust QuickStart" run: mdbook build - working-directory: docs/tutorial/rust - - name: "C++ Tutorial Docs" + working-directory: docs/quickstart/rust + - name: "C++ QuickStart" run: mdbook build - working-directory: docs/tutorial/cpp - - name: "NodeJS Tutorial Docs" + working-directory: docs/quickstart/cpp + - name: "NodeJS QuickStart" run: mdbook build - working-directory: docs/tutorial/node + working-directory: docs/quickstart/node - name: "Slint Language Documentation" run: cargo xtask slintdocs --show-warnings - name: "Node docs" @@ -115,11 +115,11 @@ jobs: target/slintdocs/html api/node/docs docs/site - docs/tutorial/rust/book/html - docs/tutorial/cpp/book/html - docs/tutorial/node/book/html + docs/quickstart/rust/book/html + docs/quickstart/cpp/book/html + docs/quickstart/node/book/html - name: "Check for docs warnings in internal crates" run: cargo doc --workspace --no-deps --all-features --exclude slint-node --exclude pyslint --exclude mcu-board-support --exclude printerdemo_mcu --exclude carousel --exclude test-* --exclude plotter --exclude uefi-demo --exclude ffmpeg --exclude gstreamer-player --exclude slint-cpp - name: Clean cache # Don't cache docs to avoid them including removed classes being published run: | - rm -rf target/doc target/cppdocs target/slintdocs api/node/docs docs/tutorial/rust/book docs/tutorial/cpp/book docs/tutorial/node/book + rm -rf target/doc target/cppdocs target/slintdocs api/node/docs docs/quickstart/rust/book docs/quickstart/cpp/book docs/quickstart/node/book diff --git a/.github/workflows/nightly_snapshot.yaml b/.github/workflows/nightly_snapshot.yaml index 7b8b2e4aee5..5c546484a57 100644 --- a/.github/workflows/nightly_snapshot.yaml +++ b/.github/workflows/nightly_snapshot.yaml @@ -378,8 +378,8 @@ jobs: sed -i "s!https://slint.dev/releases/.*/docs/!../../!" $output_path/docs/rust/slint/*.html for lang in rust cpp node; do - mkdir -p $output_path/docs/tutorial/$lang - cp -a ../docs/tutorial/$lang/book/html/* $output_path/docs/tutorial/$lang + mkdir -p $output_path/docs/quickstart/$lang + cp -a ../docs/quickstart/$lang/book/html/* $output_path/docs/quickstart/$lang done mkdir -p $output_path/docs/node cp -a ../api/node/docs/* $output_path/docs/node/ diff --git a/CMakeLists.txt b/CMakeLists.txt index ccdc3cc122c..c6c02d5d801 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -39,7 +39,7 @@ if(SLINT_BUILD_EXAMPLES) add_subdirectory(examples) endif() if(SLINT_BUILD_TESTING AND (SLINT_FEATURE_COMPILER OR SLINT_COMPILER)) - add_subdirectory(docs/tutorial/cpp/src/) + add_subdirectory(docs/quickstart/cpp/src/) endif() feature_summary(WHAT ENABLED_FEATURES DESCRIPTION "Enabled features:") diff --git a/Cargo.toml b/Cargo.toml index 23c969504c2..7e293f50913 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -10,7 +10,7 @@ members = [ 'api/rs/slint', 'api/python', 'api/wasm-interpreter', - 'docs/tutorial/rust/src', + 'docs/quickstart/rust/src', 'examples/7guis', 'examples/gallery', 'examples/imagefilter/rust', diff --git a/README.md b/README.md index 6b553f90e42..9ee3669017e 100644 --- a/README.md +++ b/README.md @@ -244,16 +244,16 @@ You can of course also contact us privately via email to [info@slint.dev](mailto [#13]: https://slint.dev/resources/gallery_screenshot.png "Gallery Demo" [#14]: https://slint.dev/demos/gallery/ [#15]: https://slint.dev/docs/cpp -[#16]: https://slint.dev/docs/tutorial/cpp +[#16]: https://slint.dev/docs/quickstart/cpp [#17]: https://github.com/slint-ui/slint-cpp-template [#18]: https://img.shields.io/crates/v/slint [#19]: https://crates.io/crates/slint [#20]: https://slint.dev/docs/rust/slint/ -[#21]: https://slint.dev/docs/tutorial/rust +[#21]: https://slint.dev/docs/quickstart/rust [#22]: https://youtu.be/WBcv4V-whHk [#23]: https://github.com/slint-ui/slint-rust-template [#24]: https://img.shields.io/npm/v/slint-ui [#25]: https://www.npmjs.com/package/slint-ui [#26]: https://slint.dev/docs/node -[#27]: https://slint.dev/docs/tutorial/node +[#27]: https://slint.dev/docs/quickstart/node [#28]: https://github.com/slint-ui/slint-nodejs-template diff --git a/api/cpp/README.md b/api/cpp/README.md index f2223e209a9..6043cfe36e6 100644 --- a/api/cpp/README.md +++ b/api/cpp/README.md @@ -8,7 +8,7 @@ Slint.cpp is the C++ API to interact with a Slint UI from C++. The complete C++ documentation can be viewed online at https://slint.dev/docs/cpp/. -If you are new to Slint, you might also consider going through our [Walk-through tutorial](https://slint.dev/docs/tutorial/cpp). +If you are new to Slint, you might also consider going through our [Walk-through tutorial](https://slint.dev/docs/quickstart/cpp). ## Installing or Building Slint @@ -250,6 +250,6 @@ int main() { That's it. For more details, check the [Online documentation](https://slint.dev/docs/cpp) and the full - [Walk-through tutorial](https://slint.dev/docs/tutorial/cpp). + [Walk-through tutorial](https://slint.dev/docs/quickstart/cpp). We also have a [Getting Started Template](https://github.com/slint-ui/slint-cpp-template) repository with the code of a minimal C++ application using Slint that can be used as a starting point to your program. diff --git a/api/cpp/docs/getting_started.md b/api/cpp/docs/getting_started.md index 98385c6195e..af18701c31e 100644 --- a/api/cpp/docs/getting_started.md +++ b/api/cpp/docs/getting_started.md @@ -83,7 +83,7 @@ the UI, read or write properties, and set callbacks. You can learn more about ho ## Tutorial -For an in-depth walk-through, read our Slint Memory Game Tutorial. +For an in-depth walk-through, read our Slint Memory Game Tutorial. It will guide you through the `.slint` mark-up language and the C++ API by building a simple memory game. diff --git a/api/node/README.md b/api/node/README.md index d3799ac7661..89c3c7dd040 100644 --- a/api/node/README.md +++ b/api/node/README.md @@ -7,7 +7,7 @@ [Slint](https://slint.dev/) is a UI toolkit that supports different programming languages. Slint-node is the integration with Node.js. -To get started you use the [walk-through tutorial](https://slint.dev/docs/tutorial/node). +To get started you use the [walk-through tutorial](https://slint.dev/docs/quickstart/node). We also have a [Getting Started Template](https://github.com/slint-ui/slint-nodejs-template) repository with the code of a minimal application using Slint that can be used as a starting point to your program. diff --git a/api/node/cover.md b/api/node/cover.md index 26d646a85b3..b26cc2d1d33 100644 --- a/api/node/cover.md +++ b/api/node/cover.md @@ -6,7 +6,7 @@ [Slint](https://slint.dev/) is a UI toolkit that supports different programming languages. Slint-node is the integration with [Node.js](https://nodejs.org/en) and [Deno](https://deno.com). -To get started you use the [walk-through tutorial](https://slint.dev/docs/tutorial/node). +To get started you use the [walk-through tutorial](https://slint.dev/docs/quickstart/node). We also have a [Getting Started Template](https://github.com/slint-ui/slint-nodejs-template) repository with the code of a minimal application using Slint that can be used as a starting point to your program. diff --git a/api/rs/slint/lib.rs b/api/rs/slint/lib.rs index 28d146e69df..9b1a3e05b5d 100644 --- a/api/rs/slint/lib.rs +++ b/api/rs/slint/lib.rs @@ -9,7 +9,7 @@ This crate is the main entry point for embedding user interfaces designed with [Slint](https://slint.rs/) in Rust programs. */ -#![doc = concat!("If you are new to Slint, start with the [Walk-through **tutorial**](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/tutorial/rust)")] +#![doc = concat!("If you are new to Slint, start with the [Walk-through **tutorial**](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/quickstart/rust)")] /*! If you are already familiar with Slint, the following topics provide related information. ## Topics diff --git a/docs/building.md b/docs/building.md index cb5ce4b5d75..bff1ba52a87 100644 --- a/docs/building.md +++ b/docs/building.md @@ -241,19 +241,19 @@ There are three tutorials built with mdbook, one for each of the three languages #### Rust tutorial ```shell -mdbook build docs/tutorial/rust +mdbook build docs/quickstart/rust ``` #### C++ tutorial ```shell -mdbook build docs/tutorial/cpp +mdbook build docs/quickstart/cpp ``` #### NodeJS tutorial ```shell -mdbook build docs/tutorial/node +mdbook build docs/quickstart/node ``` ### Slint DSL docs diff --git a/docs/tutorial/.gitignore b/docs/quickstart/.gitignore similarity index 100% rename from docs/tutorial/.gitignore rename to docs/quickstart/.gitignore diff --git a/docs/tutorial/README.md b/docs/quickstart/README.md similarity index 100% rename from docs/tutorial/README.md rename to docs/quickstart/README.md diff --git a/docs/tutorial/cpp/book.toml b/docs/quickstart/cpp/book.toml similarity index 82% rename from docs/tutorial/cpp/book.toml rename to docs/quickstart/cpp/book.toml index e21f4d9d422..065e59cef2a 100644 --- a/docs/tutorial/cpp/book.toml +++ b/docs/quickstart/cpp/book.toml @@ -3,7 +3,7 @@ authors = ["Slint Developers "] language = "en" multilingual = false src = "src" -title = "Slint Memory Game Tutorial (C++)" +title = "Slint Memory Game QuickStart (C++)" [output.html] theme = "../theme" diff --git a/docs/tutorial/cpp/src/CMakeLists.txt b/docs/quickstart/cpp/src/CMakeLists.txt similarity index 100% rename from docs/tutorial/cpp/src/CMakeLists.txt rename to docs/quickstart/cpp/src/CMakeLists.txt diff --git a/docs/tutorial/cpp/src/SUMMARY.md b/docs/quickstart/cpp/src/SUMMARY.md similarity index 100% rename from docs/tutorial/cpp/src/SUMMARY.md rename to docs/quickstart/cpp/src/SUMMARY.md diff --git a/docs/tutorial/cpp/src/appwindow.slint b/docs/quickstart/cpp/src/appwindow.slint similarity index 100% rename from docs/tutorial/cpp/src/appwindow.slint rename to docs/quickstart/cpp/src/appwindow.slint diff --git a/docs/tutorial/cpp/src/conclusion.md b/docs/quickstart/cpp/src/conclusion.md similarity index 100% rename from docs/tutorial/cpp/src/conclusion.md rename to docs/quickstart/cpp/src/conclusion.md diff --git a/docs/tutorial/cpp/src/creating_the_tiles_from_cpp.md b/docs/quickstart/cpp/src/creating_the_tiles_from_cpp.md similarity index 100% rename from docs/tutorial/cpp/src/creating_the_tiles_from_cpp.md rename to docs/quickstart/cpp/src/creating_the_tiles_from_cpp.md diff --git a/docs/tutorial/cpp/src/from_one_to_multiple_tiles.md b/docs/quickstart/cpp/src/from_one_to_multiple_tiles.md similarity index 100% rename from docs/tutorial/cpp/src/from_one_to_multiple_tiles.md rename to docs/quickstart/cpp/src/from_one_to_multiple_tiles.md diff --git a/docs/tutorial/cpp/src/game_logic_in_cpp.md b/docs/quickstart/cpp/src/game_logic_in_cpp.md similarity index 100% rename from docs/tutorial/cpp/src/game_logic_in_cpp.md rename to docs/quickstart/cpp/src/game_logic_in_cpp.md diff --git a/docs/tutorial/cpp/src/getting_started.md b/docs/quickstart/cpp/src/getting_started.md similarity index 100% rename from docs/tutorial/cpp/src/getting_started.md rename to docs/quickstart/cpp/src/getting_started.md diff --git a/docs/tutorial/cpp/src/icons b/docs/quickstart/cpp/src/icons similarity index 100% rename from docs/tutorial/cpp/src/icons rename to docs/quickstart/cpp/src/icons diff --git a/docs/tutorial/cpp/src/ideas_for_the_reader.md b/docs/quickstart/cpp/src/ideas_for_the_reader.md similarity index 100% rename from docs/tutorial/cpp/src/ideas_for_the_reader.md rename to docs/quickstart/cpp/src/ideas_for_the_reader.md diff --git a/docs/tutorial/cpp/src/introduction.md b/docs/quickstart/cpp/src/introduction.md similarity index 100% rename from docs/tutorial/cpp/src/introduction.md rename to docs/quickstart/cpp/src/introduction.md diff --git a/docs/tutorial/cpp/src/main_game_logic.cpp b/docs/quickstart/cpp/src/main_game_logic.cpp similarity index 100% rename from docs/tutorial/cpp/src/main_game_logic.cpp rename to docs/quickstart/cpp/src/main_game_logic.cpp diff --git a/docs/tutorial/cpp/src/main_initial.cpp b/docs/quickstart/cpp/src/main_initial.cpp similarity index 100% rename from docs/tutorial/cpp/src/main_initial.cpp rename to docs/quickstart/cpp/src/main_initial.cpp diff --git a/docs/tutorial/cpp/src/main_tiles_from_cpp.cpp b/docs/quickstart/cpp/src/main_tiles_from_cpp.cpp similarity index 100% rename from docs/tutorial/cpp/src/main_tiles_from_cpp.cpp rename to docs/quickstart/cpp/src/main_tiles_from_cpp.cpp diff --git a/docs/tutorial/cpp/src/memory_game_logic.slint b/docs/quickstart/cpp/src/memory_game_logic.slint similarity index 100% rename from docs/tutorial/cpp/src/memory_game_logic.slint rename to docs/quickstart/cpp/src/memory_game_logic.slint diff --git a/docs/tutorial/cpp/src/memory_tile.md b/docs/quickstart/cpp/src/memory_tile.md similarity index 100% rename from docs/tutorial/cpp/src/memory_tile.md rename to docs/quickstart/cpp/src/memory_tile.md diff --git a/docs/tutorial/cpp/src/memory_tile.slint b/docs/quickstart/cpp/src/memory_tile.slint similarity index 100% rename from docs/tutorial/cpp/src/memory_tile.slint rename to docs/quickstart/cpp/src/memory_tile.slint diff --git a/docs/tutorial/cpp/src/memory_tiles_from_cpp.slint b/docs/quickstart/cpp/src/memory_tiles_from_cpp.slint similarity index 100% rename from docs/tutorial/cpp/src/memory_tiles_from_cpp.slint rename to docs/quickstart/cpp/src/memory_tiles_from_cpp.slint diff --git a/docs/tutorial/cpp/src/polishing_the_tile.md b/docs/quickstart/cpp/src/polishing_the_tile.md similarity index 100% rename from docs/tutorial/cpp/src/polishing_the_tile.md rename to docs/quickstart/cpp/src/polishing_the_tile.md diff --git a/docs/tutorial/node/book.toml b/docs/quickstart/node/book.toml similarity index 82% rename from docs/tutorial/node/book.toml rename to docs/quickstart/node/book.toml index 30d8513ecf0..713fe113c39 100644 --- a/docs/tutorial/node/book.toml +++ b/docs/quickstart/node/book.toml @@ -3,7 +3,7 @@ authors = ["Slint Developers "] language = "en" multilingual = false src = "src" -title = "Slint Memory Game Tutorial (node)" +title = "Slint Memory Game QuickStart (node)" [output.html] theme = "../theme" diff --git a/docs/tutorial/node/src/SUMMARY.md b/docs/quickstart/node/src/SUMMARY.md similarity index 100% rename from docs/tutorial/node/src/SUMMARY.md rename to docs/quickstart/node/src/SUMMARY.md diff --git a/docs/tutorial/node/src/conclusion.md b/docs/quickstart/node/src/conclusion.md similarity index 100% rename from docs/tutorial/node/src/conclusion.md rename to docs/quickstart/node/src/conclusion.md diff --git a/docs/tutorial/node/src/creating_the_tiles_from_js.md b/docs/quickstart/node/src/creating_the_tiles_from_js.md similarity index 100% rename from docs/tutorial/node/src/creating_the_tiles_from_js.md rename to docs/quickstart/node/src/creating_the_tiles_from_js.md diff --git a/docs/tutorial/node/src/from_one_to_multiple_tiles.md b/docs/quickstart/node/src/from_one_to_multiple_tiles.md similarity index 100% rename from docs/tutorial/node/src/from_one_to_multiple_tiles.md rename to docs/quickstart/node/src/from_one_to_multiple_tiles.md diff --git a/docs/tutorial/node/src/game_logic_in_js.md b/docs/quickstart/node/src/game_logic_in_js.md similarity index 100% rename from docs/tutorial/node/src/game_logic_in_js.md rename to docs/quickstart/node/src/game_logic_in_js.md diff --git a/docs/tutorial/node/src/getting_started.md b/docs/quickstart/node/src/getting_started.md similarity index 100% rename from docs/tutorial/node/src/getting_started.md rename to docs/quickstart/node/src/getting_started.md diff --git a/docs/tutorial/node/src/icons b/docs/quickstart/node/src/icons similarity index 100% rename from docs/tutorial/node/src/icons rename to docs/quickstart/node/src/icons diff --git a/docs/tutorial/node/src/ideas_for_the_reader.md b/docs/quickstart/node/src/ideas_for_the_reader.md similarity index 100% rename from docs/tutorial/node/src/ideas_for_the_reader.md rename to docs/quickstart/node/src/ideas_for_the_reader.md diff --git a/docs/tutorial/node/src/introduction.md b/docs/quickstart/node/src/introduction.md similarity index 100% rename from docs/tutorial/node/src/introduction.md rename to docs/quickstart/node/src/introduction.md diff --git a/docs/tutorial/node/src/main_game_logic.js b/docs/quickstart/node/src/main_game_logic.js similarity index 100% rename from docs/tutorial/node/src/main_game_logic.js rename to docs/quickstart/node/src/main_game_logic.js diff --git a/docs/tutorial/node/src/main_initial.js b/docs/quickstart/node/src/main_initial.js similarity index 100% rename from docs/tutorial/node/src/main_initial.js rename to docs/quickstart/node/src/main_initial.js diff --git a/docs/tutorial/node/src/main_tiles_from_js.js b/docs/quickstart/node/src/main_tiles_from_js.js similarity index 100% rename from docs/tutorial/node/src/main_tiles_from_js.js rename to docs/quickstart/node/src/main_tiles_from_js.js diff --git a/docs/tutorial/node/src/memory.slint b/docs/quickstart/node/src/memory.slint similarity index 100% rename from docs/tutorial/node/src/memory.slint rename to docs/quickstart/node/src/memory.slint diff --git a/docs/tutorial/node/src/memory_game_logic.slint b/docs/quickstart/node/src/memory_game_logic.slint similarity index 100% rename from docs/tutorial/node/src/memory_game_logic.slint rename to docs/quickstart/node/src/memory_game_logic.slint diff --git a/docs/tutorial/node/src/memory_tile.md b/docs/quickstart/node/src/memory_tile.md similarity index 100% rename from docs/tutorial/node/src/memory_tile.md rename to docs/quickstart/node/src/memory_tile.md diff --git a/docs/tutorial/node/src/memory_tile.slint b/docs/quickstart/node/src/memory_tile.slint similarity index 100% rename from docs/tutorial/node/src/memory_tile.slint rename to docs/quickstart/node/src/memory_tile.slint diff --git a/docs/tutorial/node/src/memory_tiles_from_cpp.slint b/docs/quickstart/node/src/memory_tiles_from_cpp.slint similarity index 100% rename from docs/tutorial/node/src/memory_tiles_from_cpp.slint rename to docs/quickstart/node/src/memory_tiles_from_cpp.slint diff --git a/docs/tutorial/node/src/package.json b/docs/quickstart/node/src/package.json similarity index 100% rename from docs/tutorial/node/src/package.json rename to docs/quickstart/node/src/package.json diff --git a/docs/tutorial/node/src/polishing_the_tile.md b/docs/quickstart/node/src/polishing_the_tile.md similarity index 100% rename from docs/tutorial/node/src/polishing_the_tile.md rename to docs/quickstart/node/src/polishing_the_tile.md diff --git a/docs/tutorial/rust/book.toml b/docs/quickstart/rust/book.toml similarity index 82% rename from docs/tutorial/rust/book.toml rename to docs/quickstart/rust/book.toml index 597ff22425c..dbb106a7f76 100644 --- a/docs/tutorial/rust/book.toml +++ b/docs/quickstart/rust/book.toml @@ -3,7 +3,7 @@ authors = ["Slint Developers "] language = "en" multilingual = false src = "src" -title = "Slint Memory Game Tutorial (Rust)" +title = "Slint Memory Game QuickStart (Rust)" [output.html] theme = "../theme" diff --git a/docs/tutorial/rust/src/Cargo.toml b/docs/quickstart/rust/src/Cargo.toml similarity index 100% rename from docs/tutorial/rust/src/Cargo.toml rename to docs/quickstart/rust/src/Cargo.toml diff --git a/docs/tutorial/rust/src/SUMMARY.md b/docs/quickstart/rust/src/SUMMARY.md similarity index 100% rename from docs/tutorial/rust/src/SUMMARY.md rename to docs/quickstart/rust/src/SUMMARY.md diff --git a/docs/tutorial/rust/src/conclusion.md b/docs/quickstart/rust/src/conclusion.md similarity index 100% rename from docs/tutorial/rust/src/conclusion.md rename to docs/quickstart/rust/src/conclusion.md diff --git a/docs/tutorial/rust/src/creating_the_tiles_from_rust.md b/docs/quickstart/rust/src/creating_the_tiles_from_rust.md similarity index 100% rename from docs/tutorial/rust/src/creating_the_tiles_from_rust.md rename to docs/quickstart/rust/src/creating_the_tiles_from_rust.md diff --git a/docs/tutorial/rust/src/from_one_to_multiple_tiles.md b/docs/quickstart/rust/src/from_one_to_multiple_tiles.md similarity index 100% rename from docs/tutorial/rust/src/from_one_to_multiple_tiles.md rename to docs/quickstart/rust/src/from_one_to_multiple_tiles.md diff --git a/docs/tutorial/rust/src/game_logic_in_rust.md b/docs/quickstart/rust/src/game_logic_in_rust.md similarity index 100% rename from docs/tutorial/rust/src/game_logic_in_rust.md rename to docs/quickstart/rust/src/game_logic_in_rust.md diff --git a/docs/tutorial/rust/src/getting_started.md b/docs/quickstart/rust/src/getting_started.md similarity index 100% rename from docs/tutorial/rust/src/getting_started.md rename to docs/quickstart/rust/src/getting_started.md diff --git a/docs/tutorial/rust/src/icons b/docs/quickstart/rust/src/icons similarity index 100% rename from docs/tutorial/rust/src/icons rename to docs/quickstart/rust/src/icons diff --git a/docs/tutorial/rust/src/ideas_for_the_reader.md b/docs/quickstart/rust/src/ideas_for_the_reader.md similarity index 100% rename from docs/tutorial/rust/src/ideas_for_the_reader.md rename to docs/quickstart/rust/src/ideas_for_the_reader.md diff --git a/docs/tutorial/rust/src/introduction.md b/docs/quickstart/rust/src/introduction.md similarity index 100% rename from docs/tutorial/rust/src/introduction.md rename to docs/quickstart/rust/src/introduction.md diff --git a/docs/tutorial/rust/src/main_game_logic_in_rust.rs b/docs/quickstart/rust/src/main_game_logic_in_rust.rs similarity index 100% rename from docs/tutorial/rust/src/main_game_logic_in_rust.rs rename to docs/quickstart/rust/src/main_game_logic_in_rust.rs diff --git a/docs/tutorial/rust/src/main_initial.rs b/docs/quickstart/rust/src/main_initial.rs similarity index 100% rename from docs/tutorial/rust/src/main_initial.rs rename to docs/quickstart/rust/src/main_initial.rs diff --git a/docs/tutorial/rust/src/main_memory_tile.rs b/docs/quickstart/rust/src/main_memory_tile.rs similarity index 100% rename from docs/tutorial/rust/src/main_memory_tile.rs rename to docs/quickstart/rust/src/main_memory_tile.rs diff --git a/docs/tutorial/rust/src/main_multiple_tiles.rs b/docs/quickstart/rust/src/main_multiple_tiles.rs similarity index 100% rename from docs/tutorial/rust/src/main_multiple_tiles.rs rename to docs/quickstart/rust/src/main_multiple_tiles.rs diff --git a/docs/tutorial/rust/src/main_polishing_the_tile.rs b/docs/quickstart/rust/src/main_polishing_the_tile.rs similarity index 100% rename from docs/tutorial/rust/src/main_polishing_the_tile.rs rename to docs/quickstart/rust/src/main_polishing_the_tile.rs diff --git a/docs/tutorial/rust/src/main_tiles_from_rust.rs b/docs/quickstart/rust/src/main_tiles_from_rust.rs similarity index 100% rename from docs/tutorial/rust/src/main_tiles_from_rust.rs rename to docs/quickstart/rust/src/main_tiles_from_rust.rs diff --git a/docs/tutorial/rust/src/memory_tile.md b/docs/quickstart/rust/src/memory_tile.md similarity index 100% rename from docs/tutorial/rust/src/memory_tile.md rename to docs/quickstart/rust/src/memory_tile.md diff --git a/docs/tutorial/rust/src/polishing_the_tile.md b/docs/quickstart/rust/src/polishing_the_tile.md similarity index 100% rename from docs/tutorial/rust/src/polishing_the_tile.md rename to docs/quickstart/rust/src/polishing_the_tile.md diff --git a/docs/tutorial/rust/src/running_in_a_browser.md b/docs/quickstart/rust/src/running_in_a_browser.md similarity index 100% rename from docs/tutorial/rust/src/running_in_a_browser.md rename to docs/quickstart/rust/src/running_in_a_browser.md diff --git a/docs/tutorial/theme/head.hbs b/docs/quickstart/theme/head.hbs similarity index 100% rename from docs/tutorial/theme/head.hbs rename to docs/quickstart/theme/head.hbs diff --git a/docs/tutorial/theme/highlight.css b/docs/quickstart/theme/highlight.css similarity index 100% rename from docs/tutorial/theme/highlight.css rename to docs/quickstart/theme/highlight.css diff --git a/docs/tutorial/theme/highlight.js b/docs/quickstart/theme/highlight.js similarity index 100% rename from docs/tutorial/theme/highlight.js rename to docs/quickstart/theme/highlight.js diff --git a/docs/site/index.html b/docs/site/index.html index a70cfd4c111..770338c48ff 100644 --- a/docs/site/index.html +++ b/docs/site/index.html @@ -119,7 +119,7 @@
APIs

Using Rust

API

-

Tutorial

+

QuickStart

Video Tutorial

Project Template

@@ -128,7 +128,7 @@
APIs

Using C++

API

-

Tutorial

+

QuickStart

Project Template

@@ -136,7 +136,7 @@
APIs

Using NodeJS (beta)

API

-

Tutorial

+

QuickStart

Project Template

diff --git a/examples/README.md b/examples/README.md index 7aa612dba83..0bd0fba76fe 100644 --- a/examples/README.md +++ b/examples/README.md @@ -70,8 +70,8 @@ Puzzle game based on a Flutter example. See [Readme](./slide_puzzle) A basic memory game used as an example the tutorial: -* [Memory Game Tutorial (Rust)](https://slint.dev/docs/tutorial/rust) -* [Memory Game Tutorial (C++)](https://slint.dev/docs/tutorial/cpp) +* [Memory Game Tutorial (Rust)](https://slint.dev/docs/quickstart/rust) +* [Memory Game Tutorial (C++)](https://slint.dev/docs/quickstart/cpp) | `.slint` Design | Rust Source | C++ Source | Online wasm Preview | Open in SlintPad | | --- | --- | --- | --- | --- | diff --git a/xtask/src/license_headers_check.rs b/xtask/src/license_headers_check.rs index 669eaa7f709..7ccd2ef7ea0 100644 --- a/xtask/src/license_headers_check.rs +++ b/xtask/src/license_headers_check.rs @@ -432,7 +432,7 @@ lazy_static! { ("^editors/tree-sitter-slint/corpus/", LicenseLocation::NoLicense), // liberal license ("^api/cpp/docs/_static/", LicenseLocation::NoLicense), ("^api/cpp/docs/_templates/", LicenseLocation::NoLicense), - ("^docs/tutorial/theme/", LicenseLocation::NoLicense), + ("^docs/quickstart/theme/", LicenseLocation::NoLicense), ("^editors/tree-sitter-slint/queries/", LicenseLocation::NoLicense), // liberal license // directory based matches