fix: chapter-related folder names (#216)

* fix: chapter-related folder names * updated all references
NethermindEth · Jun 9, 2024 · 3fbfb60 · 3fbfb60
1 parent 19c67c2
commit 3fbfb60
Show file tree

Hide file tree

Showing 56 changed files with 1,125 additions and 1,126 deletions.
diff --git a/po/es.po b/po/es.po
diff --git a/po/messages.pot b/po/messages.pot
diff --git a/po/zh-cn.po b/po/zh-cn.po
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -2,44 +2,44 @@ Summary
 
 [Introduction](./starknet-by-example.md)
 
-<!-- ch00 -->
+<!-- getting-started -->
 
 # Getting Started
 
-  <!-- - [Local environment setup](./ch00/env_setup.md) -->
+  <!-- - [Local environment setup](./getting-started/env_setup.md) -->
 
-- [Basics of a Starknet contract](./ch00/basics/introduction.md)
-  - [Storage](./ch00/basics/storage.md)
-  - [Constructor](./ch00/basics/constructor.md)
-  - [Variables](./ch00/basics/variables.md)
-  - [Visibility and Mutability](./ch00/basics/visibility-mutability.md)
-  - [Counter Example](./ch00/basics/counter.md)
-  - [Mappings](./ch00/basics/mappings.md)
-  - [Errors](./ch00/basics/errors.md)
-  - [Events](./ch00/basics/events.md)
-  - [Syscalls](./ch00/basics/syscalls.md)
-  - [Strings and ByteArrays](./ch00/basics/bytearrays-strings.md)
-  - [Storing Custom Types](./ch00/basics/storing-custom-types.md)
-  - [Custom types in entrypoints](./ch00/basics/custom-types-in-entrypoints.md)
-  - [Documentation](./ch00/basics/documentation.md)
-- [Deploy and interact with contracts](./ch00/interacting/interacting.md)
-  - [Contract interfaces and Traits generation](./ch00/interacting/interfaces-traits.md)
-  - [Calling other contracts](./ch00/interacting/calling_other_contracts.md)
-  - [Factory pattern](./ch00/interacting/factory.md)
-- [Testing contracts](./ch00/testing/contract-testing.md)
-- [Cairo cheatsheet](./ch00/cairo_cheatsheet/cairo_cheatsheet.md)
-  - [Felt](./ch00/cairo_cheatsheet/felt.md)
-  - [LegacyMap](./ch00/cairo_cheatsheet/mapping.md)
-  - [Arrays](./ch00/cairo_cheatsheet/arrays.md)
-  - [loop](./ch00/cairo_cheatsheet/loop.md)
-  - [while](./ch00/cairo_cheatsheet/while.md)
-  - [if let](./ch00/cairo_cheatsheet/if_let.md)
-  - [while let](./ch00/cairo_cheatsheet/while_let.md)
-  - [Enums](./ch00/cairo_cheatsheet/enums.md)
-  - [Match](./ch00/cairo_cheatsheet/match.md)
-  - [Tuples](./ch00/cairo_cheatsheet/tuples.md)
-  - [Struct](./ch00/cairo_cheatsheet/struct.md)
-  - [Type casting](./ch00/cairo_cheatsheet/type_casting.md)
+- [Basics of a Starknet contract](./getting-started/basics/introduction.md)
+  - [Storage](./getting-started/basics/storage.md)
+  - [Constructor](./getting-started/basics/constructor.md)
+  - [Variables](./getting-started/basics/variables.md)
+  - [Visibility and Mutability](./getting-started/basics/visibility-mutability.md)
+  - [Counter Example](./getting-started/basics/counter.md)
+  - [Mappings](./getting-started/basics/mappings.md)
+  - [Errors](./getting-started/basics/errors.md)
+  - [Events](./getting-started/basics/events.md)
+  - [Syscalls](./getting-started/basics/syscalls.md)
+  - [Strings and ByteArrays](./getting-started/basics/bytearrays-strings.md)
+  - [Storing Custom Types](./getting-started/basics/storing-custom-types.md)
+  - [Custom types in entrypoints](./getting-started/basics/custom-types-in-entrypoints.md)
+  - [Documentation](./getting-started/basics/documentation.md)
+- [Deploy and interact with contracts](./getting-started/interacting/interacting.md)
+  - [Contract interfaces and Traits generation](./getting-started/interacting/interfaces-traits.md)
+  - [Calling other contracts](./getting-started/interacting/calling_other_contracts.md)
+  - [Factory pattern](./getting-started/interacting/factory.md)
+- [Testing contracts](./getting-started/testing/contract-testing.md)
+- [Cairo cheatsheet](./getting-started/cairo_cheatsheet/cairo_cheatsheet.md)
+  - [Felt](./getting-started/cairo_cheatsheet/felt.md)
+  - [LegacyMap](./getting-started/cairo_cheatsheet/mapping.md)
+  - [Arrays](./getting-started/cairo_cheatsheet/arrays.md)
+  - [loop](./getting-started/cairo_cheatsheet/loop.md)
+  - [while](./getting-started/cairo_cheatsheet/while.md)
+  - [if let](./getting-started/cairo_cheatsheet/if_let.md)
+  - [while let](./getting-started/cairo_cheatsheet/while_let.md)
+  - [Enums](./getting-started/cairo_cheatsheet/enums.md)
+  - [Match](./getting-started/cairo_cheatsheet/match.md)
+  - [Tuples](./getting-started/cairo_cheatsheet/tuples.md)
+  - [Struct](./getting-started/cairo_cheatsheet/struct.md)
+  - [Type casting](./getting-started/cairo_cheatsheet/type_casting.md)
 
 # Components
 
@@ -48,31 +48,30 @@ Summary
 - [Storage Collisions](./components/collisions.md)
 - [Ownable](./components/ownable.md)
 
-<!-- ch01 -->
+<!-- applications -->
 
 # Applications
 
-- [Upgradeable Contract](./ch01/upgradeable_contract.md)
-- [Defi Vault](./ch01/simple_vault.md)
-- [ERC20 Token](./ch01/erc20.md)
-- [NFT Dutch Auction](./ch01/nft_dutch_auction.md)
-- [Constant Product AMM](./ch01/constant-product-amm.md)
-- [TimeLock](./ch01/timelock.md)
-- [Staking](./ch01/staking.md)
+- [Upgradeable Contract](./applications/upgradeable_contract.md)
+- [Defi Vault](./applications/simple_vault.md)
+- [ERC20 Token](./applications/erc20.md)
+- [Constant Product AMM](./applications/constant-product-amm.md)
+- [TimeLock](./applications/timelock.md)
+- [Staking](./applications/staking.md)
 
-<!-- ch02 -->
+<!-- advanced-concepts -->
 
 # Advanced concepts
 
-- [Writing to any storage slot](./ch02/write_to_any_slot.md)
-- [Storing Arrays](./ch02/storing_arrays.md)
-- [Struct as mapping key](./ch02/struct-mapping-key.md)
-- [Hashing](./ch02/hashing.md)
+- [Writing to any storage slot](./advanced-concepts/write_to_any_slot.md)
+- [Storing Arrays](./advanced-concepts/storing_arrays.md)
+- [Struct as mapping key](./advanced-concepts/struct-mapping-key.md)
+- [Hashing](./advanced-concepts/hashing.md)
   <!-- Hidden until #123 is solved -->
-  <!-- - [Hash Solidity Compatible](./ch02/hash-solidity-compatible.md) -->
-- [Optimisations](./ch02/optimisations/optimisations.md)
-  - [Storage Optimisations](./ch02/optimisations/store_using_packing.md)
-- [List](./ch02/list.md)
-- [Plugins](./ch02/plugins.md)
-- [Signature Verification](./ch02/signature_verification.md)
-- [Library Calls](./ch02/library_calls.md)
+  <!-- - [Hash Solidity Compatible](./advanced-concepts/hash-solidity-compatible.md) -->
+- [Optimisations](./advanced-concepts/optimisations/optimisations.md)
+  - [Storage Optimisations](./advanced-concepts/optimisations/store_using_packing.md)
+- [List](./advanced-concepts/list.md)
+- [Plugins](./advanced-concepts/plugins.md)
+- [Signature Verification](./advanced-concepts/signature_verification.md)
+- [Library Calls](./advanced-concepts/library_calls.md)
diff --git a/src/ch02/hash-solidity-compatible.md → ...nced-concepts/hash-solidity-compatible.md b/src/ch02/hash-solidity-compatible.md → ...nced-concepts/hash-solidity-compatible.md
diff --git a/src/ch02/hashing.md → src/advanced-concepts/hashing.md b/src/ch02/hashing.md → src/advanced-concepts/hashing.md
diff --git a/src/ch02/library_calls.md → src/advanced-concepts/library_calls.md b/src/ch02/library_calls.md → src/advanced-concepts/library_calls.md
diff --git a/src/ch02/list.md → src/advanced-concepts/list.md b/src/ch02/list.md → src/advanced-concepts/list.md
diff --git a/src/ch02/optimisations/optimisations.md → ...d-concepts/optimisations/optimisations.md b/src/ch02/optimisations/optimisations.md → ...d-concepts/optimisations/optimisations.md
diff --git a/...ch02/optimisations/store_using_packing.md → ...epts/optimisations/store_using_packing.md b/...ch02/optimisations/store_using_packing.md → ...epts/optimisations/store_using_packing.md
diff --git a/src/ch02/plugins.md → src/advanced-concepts/plugins.md b/src/ch02/plugins.md → src/advanced-concepts/plugins.md
diff --git a/src/ch02/signature_verification.md → ...vanced-concepts/signature_verification.md b/src/ch02/signature_verification.md → ...vanced-concepts/signature_verification.md
diff --git a/src/ch02/storing_arrays.md → src/advanced-concepts/storing_arrays.md b/src/ch02/storing_arrays.md → src/advanced-concepts/storing_arrays.md
@@ -2,7 +2,7 @@
 
 On Starknet, complex values (e.g. tuples or structs) are stored in a continuous segment starting from the address of the storage variable. There is a limitation in Cairo that restricts complex storage values to a maximum of 256 field elements. This means that to store arrays with more than 255 elements, you would have to split them into segments of size `n <= 255` and store these segments at multiple storage addresses. There is currently no native support for storing arrays in Cairo, so you would need to write your own implementation of the `Store` trait for the array type you wish to store.
 
-However, the `ByteArray` struct can be used to store `Array<bytes31>` in storage without additional implementation. Before implementing your own `Store` trait, consider whether the `ByteArray` struct can be used to store the data you need! See the [ByteArray](../ch00/basics/bytearrays-strings.md#bytearray-long-strings) section for more information.
+However, the `ByteArray` struct can be used to store `Array<bytes31>` in storage without additional implementation. Before implementing your own `Store` trait, consider wether the `ByteArray` struct can be used to store the data you need! See the [ByteArray](../getting-started/basics/bytearrays-strings.md#bytearray-long-strings) section for more information.
 
 > Note: While storing arrays in storage is possible, it is not always recommended, as the read and write operations can get very costly. For example, reading an array of size `n` requires `n` storage reads, and writing to an array of size `n` requires `n` storage writes. If you only need to access a single element of the array at a time, it is recommended to use a `LegacyMap` and store the length in another variable instead.
 

diff --git a/src/ch02/struct-mapping-key.md → src/advanced-concepts/struct-mapping-key.md b/src/ch02/struct-mapping-key.md → src/advanced-concepts/struct-mapping-key.md
diff --git a/src/ch02/write_to_any_slot.md → src/advanced-concepts/write_to_any_slot.md b/src/ch02/write_to_any_slot.md → src/advanced-concepts/write_to_any_slot.md
diff --git a/src/ch01/constant-product-amm.md → src/applications/constant-product-amm.md b/src/ch01/constant-product-amm.md → src/applications/constant-product-amm.md
diff --git a/src/ch01/erc20.md → src/applications/erc20.md b/src/ch01/erc20.md → src/applications/erc20.md
diff --git a/src/ch01/nft_dutch_auction.md → src/applications/nft_dutch_auction.md b/src/ch01/nft_dutch_auction.md → src/applications/nft_dutch_auction.md
diff --git a/src/ch01/signature_verification.md → src/applications/signature_verification.md b/src/ch01/signature_verification.md → src/applications/signature_verification.md
diff --git a/src/ch01/simple_vault.md → src/applications/simple_vault.md b/src/ch01/simple_vault.md → src/applications/simple_vault.md
diff --git a/src/ch01/staking.md → src/applications/staking.md b/src/ch01/staking.md → src/applications/staking.md
diff --git a/src/ch01/timelock.md → src/applications/timelock.md b/src/ch01/timelock.md → src/applications/timelock.md
diff --git a/src/ch01/upgradeable_contract.md → src/applications/upgradeable_contract.md b/src/ch01/upgradeable_contract.md → src/applications/upgradeable_contract.md
diff --git a/src/ch00/basics/bytearrays-strings.md → ...ting-started/basics/bytearrays-strings.md b/src/ch00/basics/bytearrays-strings.md → ...ting-started/basics/bytearrays-strings.md
diff --git a/src/ch00/basics/constructor.md → src/getting-started/basics/constructor.md b/src/ch00/basics/constructor.md → src/getting-started/basics/constructor.md
diff --git a/src/ch00/basics/counter.md → src/getting-started/basics/counter.md b/src/ch00/basics/counter.md → src/getting-started/basics/counter.md
diff --git a/...h00/basics/custom-types-in-entrypoints.md → ...ted/basics/custom-types-in-entrypoints.md b/...h00/basics/custom-types-in-entrypoints.md → ...ted/basics/custom-types-in-entrypoints.md
diff --git a/src/ch00/basics/documentation.md → src/getting-started/basics/documentation.md b/src/ch00/basics/documentation.md → src/getting-started/basics/documentation.md
diff --git a/src/ch00/basics/errors.md → src/getting-started/basics/errors.md b/src/ch00/basics/errors.md → src/getting-started/basics/errors.md
diff --git a/src/ch00/basics/events.md → src/getting-started/basics/events.md b/src/ch00/basics/events.md → src/getting-started/basics/events.md
diff --git a/src/ch00/basics/introduction.md → src/getting-started/basics/introduction.md b/src/ch00/basics/introduction.md → src/getting-started/basics/introduction.md
diff --git a/src/ch00/basics/mappings.md → src/getting-started/basics/mappings.md b/src/ch00/basics/mappings.md → src/getting-started/basics/mappings.md
diff --git a/src/ch00/basics/storage.md → src/getting-started/basics/storage.md b/src/ch00/basics/storage.md → src/getting-started/basics/storage.md
diff --git a/src/ch00/basics/storing-custom-types.md → ...ng-started/basics/storing-custom-types.md b/src/ch00/basics/storing-custom-types.md → ...ng-started/basics/storing-custom-types.md
diff --git a/src/ch00/basics/syscalls.md → src/getting-started/basics/syscalls.md b/src/ch00/basics/syscalls.md → src/getting-started/basics/syscalls.md
@@ -201,7 +201,7 @@ fn replace_class_syscall(
 
 Replace the class of the calling contract with the class `class_hash`.
 
-This is used for contract upgrades. Here's an example from the [Upgradeable Contract](../../ch01/upgradeable_contract.md):
+This is used for contract upgrades. Here's an example from the [Upgradeable Contract](../../applications/upgradeable_contract.md):
 
 ```rust
 {{#rustdoc_include ../../../listings/applications/upgradeable_contract/src/upgradeable_contract_v0.cairo:upgrade}}

diff --git a/src/ch00/basics/variables.md → src/getting-started/basics/variables.md b/src/ch00/basics/variables.md → src/getting-started/basics/variables.md
diff --git a/src/ch00/basics/visibility-mutability.md → ...g-started/basics/visibility-mutability.md b/src/ch00/basics/visibility-mutability.md → ...g-started/basics/visibility-mutability.md
diff --git a/src/ch00/cairo_cheatsheet/arrays.md → ...etting-started/cairo_cheatsheet/arrays.md b/src/ch00/cairo_cheatsheet/arrays.md → ...etting-started/cairo_cheatsheet/arrays.md
diff --git a/...ch00/cairo_cheatsheet/cairo_cheatsheet.md → ...rted/cairo_cheatsheet/cairo_cheatsheet.md b/...ch00/cairo_cheatsheet/cairo_cheatsheet.md → ...rted/cairo_cheatsheet/cairo_cheatsheet.md
diff --git a/src/ch00/cairo_cheatsheet/enums.md → ...getting-started/cairo_cheatsheet/enums.md b/src/ch00/cairo_cheatsheet/enums.md → ...getting-started/cairo_cheatsheet/enums.md
diff --git a/src/ch00/cairo_cheatsheet/felt.md → src/getting-started/cairo_cheatsheet/felt.md b/src/ch00/cairo_cheatsheet/felt.md → src/getting-started/cairo_cheatsheet/felt.md
diff --git a/src/ch00/cairo_cheatsheet/if_let.md → ...etting-started/cairo_cheatsheet/if_let.md b/src/ch00/cairo_cheatsheet/if_let.md → ...etting-started/cairo_cheatsheet/if_let.md
diff --git a/src/ch00/cairo_cheatsheet/loop.md → src/getting-started/cairo_cheatsheet/loop.md b/src/ch00/cairo_cheatsheet/loop.md → src/getting-started/cairo_cheatsheet/loop.md
diff --git a/src/ch00/cairo_cheatsheet/mapping.md → ...tting-started/cairo_cheatsheet/mapping.md b/src/ch00/cairo_cheatsheet/mapping.md → ...tting-started/cairo_cheatsheet/mapping.md
diff --git a/src/ch00/cairo_cheatsheet/match.md → ...getting-started/cairo_cheatsheet/match.md b/src/ch00/cairo_cheatsheet/match.md → ...getting-started/cairo_cheatsheet/match.md
diff --git a/src/ch00/cairo_cheatsheet/struct.md → ...etting-started/cairo_cheatsheet/struct.md b/src/ch00/cairo_cheatsheet/struct.md → ...etting-started/cairo_cheatsheet/struct.md
diff --git a/src/ch00/cairo_cheatsheet/tuples.md → ...etting-started/cairo_cheatsheet/tuples.md b/src/ch00/cairo_cheatsheet/tuples.md → ...etting-started/cairo_cheatsheet/tuples.md
diff --git a/src/ch00/cairo_cheatsheet/type_casting.md → ...-started/cairo_cheatsheet/type_casting.md b/src/ch00/cairo_cheatsheet/type_casting.md → ...-started/cairo_cheatsheet/type_casting.md
diff --git a/src/ch00/cairo_cheatsheet/while.md → ...getting-started/cairo_cheatsheet/while.md b/src/ch00/cairo_cheatsheet/while.md → ...getting-started/cairo_cheatsheet/while.md
diff --git a/src/ch00/cairo_cheatsheet/while_let.md → ...ing-started/cairo_cheatsheet/while_let.md b/src/ch00/cairo_cheatsheet/while_let.md → ...ing-started/cairo_cheatsheet/while_let.md
diff --git a/src/ch00/env_setup.md → src/getting-started/env_setup.md b/src/ch00/env_setup.md → src/getting-started/env_setup.md
diff --git a/...00/interacting/calling_other_contracts.md → ...ed/interacting/calling_other_contracts.md b/...00/interacting/calling_other_contracts.md → ...ed/interacting/calling_other_contracts.md
diff --git a/src/ch00/interacting/factory.md → src/getting-started/interacting/factory.md b/src/ch00/interacting/factory.md → src/getting-started/interacting/factory.md
diff --git a/src/ch00/interacting/interacting.md → ...etting-started/interacting/interacting.md b/src/ch00/interacting/interacting.md → ...etting-started/interacting/interacting.md
diff --git a/src/ch00/interacting/interfaces-traits.md → ...-started/interacting/interfaces-traits.md b/src/ch00/interacting/interfaces-traits.md → ...-started/interacting/interfaces-traits.md
diff --git a/src/ch00/testing/contract-testing.md → ...tting-started/testing/contract-testing.md b/src/ch00/testing/contract-testing.md → ...tting-started/testing/contract-testing.md