Move tutorials, rename docs (unicode-org#4694)

Fixes unicode-org#4569
hsivonen · Mar 19, 2024 · 16c7584 · 16c7584
1 parent b1ca8b6
commit 16c7584
Show file tree

Hide file tree

Showing 221 changed files with 326 additions and 1,511 deletions.
diff --git a/.github/workflows/artifacts-build.yml b/.github/workflows/artifacts-build.yml
@@ -186,7 +186,7 @@ jobs:
         cd ffi/npm
         make lib/index.mjs
         npm install typedoc
-        node_modules/typedoc/bin/typedoc lib/index.d.ts --out docs --readme ../../docs/tutorials/js.md --basePath lib
+        node_modules/typedoc/bin/typedoc lib/index.d.ts --out docs --readme ../../tutorials/js.md --basePath lib
         cd ../..
         
     - name: Upload docs to Google Cloud Storage (non-main)
@@ -282,19 +282,19 @@ jobs:
     - name: Init packages
       run: |
         npm -C ffi/npm ci
-        npm -C docs/tutorials/npm ci
+        npm -C tutorials/npm ci
 
     - name: Run Webpack
-      run: npm -C docs/tutorials/npm run build
+      run: npm -C tutorials/npm run build
 
     - name: Put index.html in dist for temp URL
       run: |
-        cp docs/tutorials/npm/index.html docs/tutorials/npm/dist/index.html
-        printf "const gcs=document.createElement('script');gcs.setAttribute('src','./bundle.js');document.body.appendChild(gcs);" > docs/tutorials/npm/dist/index.js
+        cp tutorials/npm/index.html tutorials/npm/dist/index.html
+        printf "const gcs=document.createElement('script');gcs.setAttribute('src','./bundle.js');document.body.appendChild(gcs);" > tutorials/npm/dist/index.js
 
     - name: Upload wasm-demo bundle to Google Cloud Storage
       run: |
-        gsutil -m cp -r docs/tutorials/npm/dist/* gs://${{ env.GCP_MAIN_BUCKET_ID }}/gha/wasm-demo
+        gsutil -m cp -r tutorials/npm/dist/* gs://${{ env.GCP_MAIN_BUCKET_ID }}/gha/wasm-demo
 
     - name: "⭐⭐⭐ Links to Uploaded Artifacts ⭐⭐⭐"
       run: |

diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -468,8 +468,8 @@ jobs:
       id: gn-third-party-tools-cache
       with:
         path: |
-          docs/tutorials/gn/third_party_tools
-        key: ${{ runner.os }}-${{ hashFiles('tools/make/gn.toml', 'docs/tutorials/gn/Cargo.lock') }}
+          tutorials/gn/third_party_tools
+        key: ${{ runner.os }}-${{ hashFiles('tools/make/gn.toml', 'tutorials/gn/Cargo.lock') }}
     - name: Install GN Third-Party Tools
       if: steps.gn-third-party-tools-cache.outputs.cache-hit != 'true'
       run: cargo make gn-install

diff --git a/.gn b/.gn
@@ -1,2 +1,2 @@
-buildconfig = "//docs/tutorials/gn/BUILDCONFIG.gn"
-root = "//docs/tutorials/gn:default"
+buildconfig = "//tutorials/gn/BUILDCONFIG.gn"
+root = "//tutorials/gn:default"
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -23,7 +23,7 @@ components/normalizer/            @hsivonen @echeran
 components/plurals/               @zbraniecki @sffc
 components/segmenter/             @aethanyc @makotokato @sffc
 components/timezone/              @nordzilla
-docs/tutorials/gn/                @sffc
+tutorials/gn/                @sffc
 ffi/capi/                         @Manishearth
 ffi/ecma402/                      @filmil
 ffi/harfbuzz/                     @hsivonen

diff --git a/Cargo.toml b/Cargo.toml
@@ -5,7 +5,7 @@
 [workspace]
 resolver = "2"
 members = [
-    # KEEP IN SYNC WITH workspace.dependencies and docs/tutorials/.cargo/config.toml
+    # KEEP IN SYNC WITH workspace.dependencies and tutorials/.cargo/config.toml
 
     # Components
     "components/calendar",
@@ -89,7 +89,7 @@ members = [
     "tools/md-tests",
     "ffi/dart/tools/datagen",
 ]
-# Note: Workspaces in subdirectories, such as docs/tutorials/crates, are
+# Note: Workspaces in subdirectories, such as tutorials/crates, are
 # implicitly excluded from the main workspace.
 exclude = [
     # Testdata will still be published in the 1.x stream, but is deprecated
@@ -98,7 +98,7 @@ exclude = [
     # first.
     "provider/testdata",
     # Tutorials are tested outside the workspace to simulate external users
-    "docs",
+    "tutorials",
 ]
 
 [workspace.package]
@@ -122,7 +122,7 @@ include = [
 ]
 
 [workspace.dependencies]
-# KEEP IN SYNC WITH workspace.members and docs/tutorials/.cargo/config.toml
+# KEEP IN SYNC WITH workspace.members and tutorials/.cargo/config.toml
 
 # Components
 icu = { version = "~1.4.0", path = "components/icu", default-features = false }

diff --git a/Makefile.toml b/Makefile.toml
@@ -3,7 +3,7 @@
 # (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
 
 extend = [
-    { path = "./docs/tutorials/gn/gn.toml"}, #
+    { path = "./tutorials/gn/gn.toml"}, #
     { path = "./tools/make/data.toml"}, #
     { path = "./tools/make/valgrind.toml"}, #
     { path = "./tools/make/tidy.toml"}, #

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ The design goals of `ICU4X` are:
 
 ## Documentation
 
-For an introduction to the project, please visit the ["Introduction to ICU4X for Rust"](docs/tutorials/intro.md) tutorial. Further tutorials can be found in the [tutorial index](docs/tutorials/index.md).
+For an introduction to the project, please visit the ["Introduction to ICU4X for Rust"](tutorials/intro.md) tutorial. Further tutorials can be found in the [tutorial index](tutorials/index.md).
 
 For technical information on how to use ICU4X, visit our [API docs (latest stable)](https://docs.rs/icu/latest/) or [API docs (tip of main)](https://unicode-org.github.io/icu4x/rustdoc/icu/).
 

diff --git a/components/calendar/src/lib.rs b/components/calendar/src/lib.rs
@@ -93,7 +93,7 @@
 //! ```
 //! [`ICU4X`]: ../icu/index.html
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/casemap/src/lib.rs b/components/casemap/src/lib.rs
@@ -27,7 +27,7 @@
 //!
 //! [`ICU4X`]: ../icu/index.html
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/collator/src/lib.rs b/components/collator/src/lib.rs
@@ -6,7 +6,7 @@
 // adapted from ICU4C and, therefore, are subject to the ICU license as
 // described in LICENSE.
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/collections/src/codepointtrie/cptrie.rs b/components/collections/src/codepointtrie/cptrie.rs
@@ -31,7 +31,7 @@ use zerovec::ZeroVecError;
 /// the index array is larger. The minimum size is the "fast max" limit, which is the limit of the range
 /// of code points with 2 array lookups.
 ///
-/// See the document [Unicode Properties and Code Point Tries in ICU4X](https://github.com/unicode-org/icu4x/blob/main/docs/design/properties_code_point_trie.md).
+/// See the document [Unicode Properties and Code Point Tries in ICU4X](https://github.com/unicode-org/icu4x/blob/main/documents/design/properties_code_point_trie.md).
 ///
 /// Also see [`UCPTrieType`](https://unicode-org.github.io/icu-docs/apidoc/dev/icu4c/ucptrie_8h.html) in ICU4C.
 #[derive(Clone, Copy, PartialEq, Debug, Eq)]

diff --git a/components/collections/src/lib.rs b/components/collections/src/lib.rs
@@ -20,7 +20,7 @@
 //! It is an implementation of the existing [ICU4C UCharsTrie](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1UCharsTrie.html)
 //! / [ICU4J CharsTrie](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/CharsTrie.html) API.
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/datetime/src/lib.rs b/components/datetime/src/lib.rs
@@ -112,7 +112,7 @@
 //! [`timezone::CustomTimeZone`]: icu::timezone::{CustomTimeZone}
 //! [`TimeZoneFormatter`]: time_zone::TimeZoneFormatter
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/decimal/src/lib.rs b/components/decimal/src/lib.rs
@@ -74,7 +74,7 @@
 //!
 //! [`FixedDecimalFormatter`]: FixedDecimalFormatter
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/experimental/src/compactdecimal/mod.rs b/components/experimental/src/compactdecimal/mod.rs
@@ -4,7 +4,7 @@
 
 //! Compact decimal
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(
     not(test),
     deny(

diff --git a/components/experimental/src/displaynames/mod.rs b/components/experimental/src/displaynames/mod.rs
@@ -6,7 +6,7 @@
 
 // TODO: expand documentation
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(
     not(test),
     deny(

diff --git a/components/experimental/src/lib.rs b/components/experimental/src/lib.rs
@@ -7,7 +7,7 @@
 //! It will usually undergo a major SemVer bump for every ICU4X release. Components in this
 //! crate will eventually stabilize and move to the `icu` crate.
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 // No boilerplate, each module has their own
 #![allow(clippy::module_inception)]

diff --git a/components/experimental/src/transliterate/mod.rs b/components/experimental/src/transliterate/mod.rs
@@ -6,7 +6,7 @@
 //!
 //! See [`Transliterator`].
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(
     not(test),
     deny(

diff --git a/components/experimental/src/unicodeset_parse/mod.rs b/components/experimental/src/unicodeset_parse/mod.rs
@@ -9,7 +9,7 @@
 //!
 //! [`ICU4X`]: ../icu/index.html
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(
     not(test),
     deny(

diff --git a/components/icu/README.md b/components/icu/README.md
diff --git a/components/icu/src/lib.rs b/components/icu/src/lib.rs
@@ -128,9 +128,9 @@
 //! [`Locale`]: crate::locid::Locale
 //! [`SymbolsV1`]: crate::decimal::provider::DecimalSymbolsV1
 //! [`icu4x-datagen`]: https://docs.rs/icu_datagen/latest/icu_datagen/
-//! [data management tutorial]: https://github.com/unicode-org/icu4x/blob/main/docs/tutorials/data_provider.md#loading-additional-data-at-runtime
+//! [data management tutorial]: https://github.com/unicode-org/icu4x/blob/main/tutorials/data_provider.md#loading-additional-data-at-runtime
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/locid/src/lib.rs b/components/locid/src/lib.rs
@@ -46,7 +46,7 @@
 //! [`ICU4X`]: ../icu/index.html
 //! [`Unicode Extensions`]: extensions
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/locid_transform/src/lib.rs b/components/locid_transform/src/lib.rs
@@ -70,7 +70,7 @@
 //! [`UTS #35: Unicode LDML 3. Likely Subtags`]: https://www.unicode.org/reports/tr35/#Likely_Subtags.
 //! [`UTS #35: Unicode LDML 3. LocaleId Canonicalization`]: http://unicode.org/reports/tr35/#LocaleId_Canonicalization,
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/normalizer/src/lib.rs b/components/normalizer/src/lib.rs
@@ -2,7 +2,7 @@
 // called LICENSE at the top level of the ICU4X source tree
 // (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/plurals/src/lib.rs b/components/plurals/src/lib.rs
@@ -58,7 +58,7 @@
 //!
 //! [Language Plural Rules]: https://unicode.org/reports/tr35/tr35-numbers.html#Language_Plural_Rules
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/properties/src/lib.rs b/components/properties/src/lib.rs
@@ -51,7 +51,7 @@
 //! [`CodePointMapData`]: crate::maps::CodePointMapData
 //! [`sets`]: crate::sets
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/segmenter/src/lib.rs b/components/segmenter/src/lib.rs
@@ -99,7 +99,7 @@
 //!
 //! See [`SentenceSegmenter`] for more examples.
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/components/timezone/src/lib.rs b/components/timezone/src/lib.rs
@@ -107,7 +107,7 @@
 //! assert_eq!("amce", time_zone.metazone_id.unwrap().0.as_str());
 //! ```
 
-// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
+// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 #![cfg_attr(
     not(test),

diff --git a/docs/tutorials/.cargo/config.toml b/docs/tutorials/.cargo/config.toml
diff --git a/docs/README.md → documents/README.md b/docs/README.md → documents/README.md
diff --git a/docs/assets/data_lifecycle.svg → documents/assets/data_lifecycle.svg b/docs/assets/data_lifecycle.svg → documents/assets/data_lifecycle.svg
diff --git a/docs/assets/ergonomic_logical.svg → documents/assets/ergonomic_logical.svg b/docs/assets/ergonomic_logical.svg → documents/assets/ergonomic_logical.svg
diff --git a/docs/assets/json_data_provider.svg → documents/assets/json_data_provider.svg b/docs/assets/json_data_provider.svg → documents/assets/json_data_provider.svg
diff --git a/docs/assets/multi_provider_architecture.svg → ...ts/assets/multi_provider_architecture.svg b/docs/assets/multi_provider_architecture.svg → ...ts/assets/multi_provider_architecture.svg
diff --git a/docs/assets/reviewers-1.png → documents/assets/reviewers-1.png b/docs/assets/reviewers-1.png → documents/assets/reviewers-1.png
diff --git a/docs/assets/reviewers-2.png → documents/assets/reviewers-2.png b/docs/assets/reviewers-2.png → documents/assets/reviewers-2.png
diff --git a/docs/assets/reviewers-3.png → documents/assets/reviewers-3.png b/docs/assets/reviewers-3.png → documents/assets/reviewers-3.png
diff --git a/docs/design/data_pipeline.md → documents/design/data_pipeline.md b/docs/design/data_pipeline.md → documents/design/data_pipeline.md
diff --git a/docs/design/data_safety.md → documents/design/data_safety.md b/docs/design/data_safety.md → documents/design/data_safety.md
diff --git a/docs/design/enums_or_ids.md → documents/design/enums_or_ids.md b/docs/design/enums_or_ids.md → documents/design/enums_or_ids.md
diff --git a/...design/locale_fallback_and_negotiation.md → ...design/locale_fallback_and_negotiation.md b/...design/locale_fallback_and_negotiation.md → ...design/locale_fallback_and_negotiation.md
diff --git a/docs/design/principles.md → documents/design/principles.md b/docs/design/principles.md → documents/design/principles.md
diff --git a/docs/design/properties_code_point_trie.md → ...ents/design/properties_code_point_trie.md b/docs/design/properties_code_point_trie.md → ...ents/design/properties_code_point_trie.md
diff --git a/docs/design/string_representation.md → documents/design/string_representation.md b/docs/design/string_representation.md → documents/design/string_representation.md
diff --git a/docs/design/why_rust.md → documents/design/why_rust.md b/docs/design/why_rust.md → documents/design/why_rust.md
diff --git a/docs/minutes/icu4x-tc_2024-03-14.md → documents/minutes/icu4x-tc_2024-03-14.md b/docs/minutes/icu4x-tc_2024-03-14.md → documents/minutes/icu4x-tc_2024-03-14.md
diff --git a/...ts/20201015_ICU4X_Project_Announcement.md → ...ts/20201015_ICU4X_Project_Announcement.md b/...ts/20201015_ICU4X_Project_Announcement.md → ...ts/20201015_ICU4X_Project_Announcement.md
@@ -30,7 +30,7 @@ ICU4X is highly modular allowing users to easily select and chunk pieces of the
 
 ### Flexible Data Management
 
-[Data management](https://github.com/unicode-org/icu4x/blob/main/docs/design/data_pipeline.md) is a complex subcomponent of every internationalization ecosystem. Inflexible data management forces users to select which data and which locales are going to be available to users, which is a practice that goes against the idea of universal access to the system.
+[Data management](https://github.com/unicode-org/icu4x/blob/main/documents/design/data_pipeline.md) is a complex subcomponent of every internationalization ecosystem. Inflexible data management forces users to select which data and which locales are going to be available to users, which is a practice that goes against the idea of universal access to the system.
 
 What’s more, such architecture forces trade-offs and compromises in which benefiting some users puts additional cost on other users, companies and degrades performance.