Skip to content

Commit 16c7584

Browse files
robertbastianrobertbastian
authored
Move tutorials, rename docs (#4694)
Fixes #4569
1 parent b1ca8b6 commit 16c7584

File tree

221 files changed

+326
-1511
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

221 files changed

+326
-1511
lines changed

‎.github/workflows/artifacts-build.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ jobs:
186186
cd ffi/npm
187187
make lib/index.mjs
188188
npm install typedoc
189-
node_modules/typedoc/bin/typedoc lib/index.d.ts --out docs --readme ../../docs/tutorials/js.md --basePath lib
189+
node_modules/typedoc/bin/typedoc lib/index.d.ts --out docs --readme ../../tutorials/js.md --basePath lib
190190
cd ../..
191191
192192
- name: Upload docs to Google Cloud Storage (non-main)
@@ -282,19 +282,19 @@ jobs:
282282
- name: Init packages
283283
run: |
284284
npm -C ffi/npm ci
285-
npm -C docs/tutorials/npm ci
285+
npm -C tutorials/npm ci
286286
287287
- name: Run Webpack
288-
run: npm -C docs/tutorials/npm run build
288+
run: npm -C tutorials/npm run build
289289

290290
- name: Put index.html in dist for temp URL
291291
run: |
292-
cp docs/tutorials/npm/index.html docs/tutorials/npm/dist/index.html
293-
printf "const gcs=document.createElement('script');gcs.setAttribute('src','./bundle.js');document.body.appendChild(gcs);" > docs/tutorials/npm/dist/index.js
292+
cp tutorials/npm/index.html tutorials/npm/dist/index.html
293+
printf "const gcs=document.createElement('script');gcs.setAttribute('src','./bundle.js');document.body.appendChild(gcs);" > tutorials/npm/dist/index.js
294294
295295
- name: Upload wasm-demo bundle to Google Cloud Storage
296296
run: |
297-
gsutil -m cp -r docs/tutorials/npm/dist/* gs://${{ env.GCP_MAIN_BUCKET_ID }}/gha/wasm-demo
297+
gsutil -m cp -r tutorials/npm/dist/* gs://${{ env.GCP_MAIN_BUCKET_ID }}/gha/wasm-demo
298298
299299
- name: "⭐⭐⭐ Links to Uploaded Artifacts ⭐⭐⭐"
300300
run: |

‎.github/workflows/build-test.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -468,8 +468,8 @@ jobs:
468468
id: gn-third-party-tools-cache
469469
with:
470470
path: |
471-
docs/tutorials/gn/third_party_tools
472-
key: ${{ runner.os }}-${{ hashFiles('tools/make/gn.toml', 'docs/tutorials/gn/Cargo.lock') }}
471+
tutorials/gn/third_party_tools
472+
key: ${{ runner.os }}-${{ hashFiles('tools/make/gn.toml', 'tutorials/gn/Cargo.lock') }}
473473
- name: Install GN Third-Party Tools
474474
if: steps.gn-third-party-tools-cache.outputs.cache-hit != 'true'
475475
run: cargo make gn-install

‎.gn

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
buildconfig = "//docs/tutorials/gn/BUILDCONFIG.gn"
2-
root = "//docs/tutorials/gn:default"
1+
buildconfig = "//tutorials/gn/BUILDCONFIG.gn"
2+
root = "//tutorials/gn:default"

‎CODEOWNERS

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ components/normalizer/ @hsivonen @echeran
2323
components/plurals/ @zbraniecki @sffc
2424
components/segmenter/ @aethanyc @makotokato @sffc
2525
components/timezone/ @nordzilla
26-
docs/tutorials/gn/ @sffc
26+
tutorials/gn/ @sffc
2727
ffi/capi/ @Manishearth
2828
ffi/ecma402/ @filmil
2929
ffi/harfbuzz/ @hsivonen

‎Cargo.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[workspace]
66
resolver = "2"
77
members = [
8-
# KEEP IN SYNC WITH workspace.dependencies and docs/tutorials/.cargo/config.toml
8+
# KEEP IN SYNC WITH workspace.dependencies and tutorials/.cargo/config.toml
99

1010
# Components
1111
"components/calendar",
@@ -89,7 +89,7 @@ members = [
8989
"tools/md-tests",
9090
"ffi/dart/tools/datagen",
9191
]
92-
# Note: Workspaces in subdirectories, such as docs/tutorials/crates, are
92+
# Note: Workspaces in subdirectories, such as tutorials/crates, are
9393
# implicitly excluded from the main workspace.
9494
exclude = [
9595
# Testdata will still be published in the 1.x stream, but is deprecated
@@ -98,7 +98,7 @@ exclude = [
9898
# first.
9999
"provider/testdata",
100100
# Tutorials are tested outside the workspace to simulate external users
101-
"docs",
101+
"tutorials",
102102
]
103103

104104
[workspace.package]
@@ -122,7 +122,7 @@ include = [
122122
]
123123

124124
[workspace.dependencies]
125-
# KEEP IN SYNC WITH workspace.members and docs/tutorials/.cargo/config.toml
125+
# KEEP IN SYNC WITH workspace.members and tutorials/.cargo/config.toml
126126

127127
# Components
128128
icu = { version = "~1.4.0", path = "components/icu", default-features = false }

‎Makefile.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
44

55
extend = [
6-
{ path = "./docs/tutorials/gn/gn.toml"}, #
6+
{ path = "./tutorials/gn/gn.toml"}, #
77
{ path = "./tools/make/data.toml"}, #
88
{ path = "./tools/make/valgrind.toml"}, #
99
{ path = "./tools/make/tidy.toml"}, #

‎README.md

+1-1

‎components/calendar/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
//! ```
9494
//! [`ICU4X`]: ../icu/index.html
9595
96-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
96+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
9797
#![cfg_attr(not(any(test, feature = "std")), no_std)]
9898
#![cfg_attr(
9999
not(test),

‎components/casemap/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
//!
2828
//! [`ICU4X`]: ../icu/index.html
2929
30-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
30+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
3131
#![cfg_attr(not(any(test, feature = "std")), no_std)]
3232
#![cfg_attr(
3333
not(test),

‎components/collator/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
// adapted from ICU4C and, therefore, are subject to the ICU license as
77
// described in LICENSE.
88

9-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
9+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
1010
#![cfg_attr(not(any(test, feature = "std")), no_std)]
1111
#![cfg_attr(
1212
not(test),

‎components/collections/src/codepointtrie/cptrie.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use zerovec::ZeroVecError;
3131
/// the index array is larger. The minimum size is the "fast max" limit, which is the limit of the range
3232
/// of code points with 2 array lookups.
3333
///
34-
/// 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).
34+
/// 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).
3535
///
3636
/// Also see [`UCPTrieType`](https://unicode-org.github.io/icu-docs/apidoc/dev/icu4c/ucptrie_8h.html) in ICU4C.
3737
#[derive(Clone, Copy, PartialEq, Debug, Eq)]

‎components/collections/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
//! It is an implementation of the existing [ICU4C UCharsTrie](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classicu_1_1UCharsTrie.html)
2121
//! / [ICU4J CharsTrie](https://unicode-org.github.io/icu-docs/apidoc/released/icu4j/com/ibm/icu/util/CharsTrie.html) API.
2222
23-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
23+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
2424
#![cfg_attr(not(any(test, feature = "std")), no_std)]
2525
#![cfg_attr(
2626
not(test),

‎components/datetime/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
//! [`timezone::CustomTimeZone`]: icu::timezone::{CustomTimeZone}
113113
//! [`TimeZoneFormatter`]: time_zone::TimeZoneFormatter
114114
115-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
115+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
116116
#![cfg_attr(not(any(test, feature = "std")), no_std)]
117117
#![cfg_attr(
118118
not(test),

‎components/decimal/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
//!
7575
//! [`FixedDecimalFormatter`]: FixedDecimalFormatter
7676
77-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
77+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
7878
#![cfg_attr(not(any(test, feature = "std")), no_std)]
7979
#![cfg_attr(
8080
not(test),

‎components/experimental/src/compactdecimal/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
//! Compact decimal
66
7-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
7+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
88
#![cfg_attr(
99
not(test),
1010
deny(

‎components/experimental/src/displaynames/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
// TODO: expand documentation
88

9-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
9+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
1010
#![cfg_attr(
1111
not(test),
1212
deny(

‎components/experimental/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
//! It will usually undergo a major SemVer bump for every ICU4X release. Components in this
88
//! crate will eventually stabilize and move to the `icu` crate.
99
10-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
10+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
1111
#![cfg_attr(not(any(test, feature = "std")), no_std)]
1212
// No boilerplate, each module has their own
1313
#![allow(clippy::module_inception)]

‎components/experimental/src/transliterate/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
//!
77
//! See [`Transliterator`].
88
9-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
9+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
1010
#![cfg_attr(
1111
not(test),
1212
deny(

‎components/experimental/src/unicodeset_parse/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//!
1010
//! [`ICU4X`]: ../icu/index.html
1111
12-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
12+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
1313
#![cfg_attr(
1414
not(test),
1515
deny(

‎components/icu/README.md

+1-1

‎components/icu/src/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,9 @@
128128
//! [`Locale`]: crate::locid::Locale
129129
//! [`SymbolsV1`]: crate::decimal::provider::DecimalSymbolsV1
130130
//! [`icu4x-datagen`]: https://docs.rs/icu_datagen/latest/icu_datagen/
131-
//! [data management tutorial]: https://github.com/unicode-org/icu4x/blob/main/docs/tutorials/data_provider.md#loading-additional-data-at-runtime
131+
//! [data management tutorial]: https://github.com/unicode-org/icu4x/blob/main/tutorials/data_provider.md#loading-additional-data-at-runtime
132132
133-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
133+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
134134
#![cfg_attr(not(any(test, feature = "std")), no_std)]
135135
#![cfg_attr(
136136
not(test),

‎components/locid/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
//! [`ICU4X`]: ../icu/index.html
4747
//! [`Unicode Extensions`]: extensions
4848
49-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
49+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
5050
#![cfg_attr(not(any(test, feature = "std")), no_std)]
5151
#![cfg_attr(
5252
not(test),

‎components/locid_transform/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
//! [`UTS #35: Unicode LDML 3. Likely Subtags`]: https://www.unicode.org/reports/tr35/#Likely_Subtags.
7171
//! [`UTS #35: Unicode LDML 3. LocaleId Canonicalization`]: http://unicode.org/reports/tr35/#LocaleId_Canonicalization,
7272
73-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
73+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
7474
#![cfg_attr(not(any(test, feature = "std")), no_std)]
7575
#![cfg_attr(
7676
not(test),

‎components/normalizer/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// called LICENSE at the top level of the ICU4X source tree
33
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
44

5-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
5+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
66
#![cfg_attr(not(any(test, feature = "std")), no_std)]
77
#![cfg_attr(
88
not(test),

‎components/plurals/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
//!
5959
//! [Language Plural Rules]: https://unicode.org/reports/tr35/tr35-numbers.html#Language_Plural_Rules
6060
61-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
61+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
6262
#![cfg_attr(not(any(test, feature = "std")), no_std)]
6363
#![cfg_attr(
6464
not(test),

‎components/properties/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
//! [`CodePointMapData`]: crate::maps::CodePointMapData
5252
//! [`sets`]: crate::sets
5353
54-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
54+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
5555
#![cfg_attr(not(any(test, feature = "std")), no_std)]
5656
#![cfg_attr(
5757
not(test),

‎components/segmenter/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
//!
100100
//! See [`SentenceSegmenter`] for more examples.
101101
102-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
102+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
103103
#![cfg_attr(not(any(test, feature = "std")), no_std)]
104104
#![cfg_attr(
105105
not(test),

‎components/timezone/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107
//! assert_eq!("amce", time_zone.metazone_id.unwrap().0.as_str());
108108
//! ```
109109
110-
// https://github.com/unicode-org/icu4x/blob/main/docs/process/boilerplate.md#library-annotations
110+
// https://github.com/unicode-org/icu4x/blob/main/documents/process/boilerplate.md#library-annotations
111111
#![cfg_attr(not(any(test, feature = "std")), no_std)]
112112
#![cfg_attr(
113113
not(test),

‎docs/tutorials/.cargo/config.toml

-80
This file was deleted.

‎docs/README.md ‎documents/README.md

‎docs/assets/data_lifecycle.svg ‎documents/assets/data_lifecycle.svg

File renamed without changes.

‎docs/assets/ergonomic_logical.svg ‎documents/assets/ergonomic_logical.svg

File renamed without changes.

‎docs/assets/json_data_provider.svg ‎documents/assets/json_data_provider.svg

File renamed without changes.

‎docs/assets/multi_provider_architecture.svg ‎documents/assets/multi_provider_architecture.svg

File renamed without changes.

‎docs/assets/reviewers-1.png ‎documents/assets/reviewers-1.png

File renamed without changes.

‎docs/assets/reviewers-2.png ‎documents/assets/reviewers-2.png

File renamed without changes.

‎docs/assets/reviewers-3.png ‎documents/assets/reviewers-3.png

File renamed without changes.

‎docs/design/data_pipeline.md ‎documents/design/data_pipeline.md

‎docs/design/data_safety.md ‎documents/design/data_safety.md

‎docs/design/enums_or_ids.md ‎documents/design/enums_or_ids.md

‎docs/design/locale_fallback_and_negotiation.md ‎documents/design/locale_fallback_and_negotiation.md

‎docs/design/principles.md ‎documents/design/principles.md

‎docs/design/properties_code_point_trie.md ‎documents/design/properties_code_point_trie.md

‎docs/design/string_representation.md ‎documents/design/string_representation.md

‎docs/design/why_rust.md ‎documents/design/why_rust.md

‎docs/minutes/icu4x-tc_2024-03-14.md ‎documents/minutes/icu4x-tc_2024-03-14.md

‎docs/posts/20201015_ICU4X_Project_Announcement.md ‎documents/posts/20201015_ICU4X_Project_Announcement.md

+1-1

0 commit comments

Comments
 (0)