feat: revised book structure (#94)

NethermindEth · Oct 12, 2023 · 90aa7c0 · 90aa7c0
1 parent fe95c46
commit 90aa7c0
Show file tree

Hide file tree

Showing 125 changed files with 118 additions and 96 deletions.
diff --git a/book.toml b/book.toml
@@ -1,18 +1,19 @@
 [book]
-authors = ["msaug"]
+authors = ["msaug", "julio4"]
 language = "en"
 multilingual = false
 src = "src"
 title = "Starknet by Example"
 
 [build]
-# Eventual translations
-# extra-watch-dirs = ["po"]
+extra-watch-dirs = ["listings"]
 
 [preprocessor.gettext]
 after = ["links"]
 
 [output.html]
 git-repository-url = "https://github.com/NethermindEth/StarknetByExample/"
 edit-url-template = "https://github.com/NethermindEth/StarknetByExample/edit/main/{path}"
-playground.runnable = false
+playground.runnable = false
+fold.enable = true
+fold.level = 2
diff --git a/...uction/calling_other_contracts/.gitignore → ...tarted/calling_other_contracts/.gitignore b/...uction/calling_other_contracts/.gitignore → ...tarted/calling_other_contracts/.gitignore
diff --git a/...uction/calling_other_contracts/Scarb.toml → ...tarted/calling_other_contracts/Scarb.toml b/...uction/calling_other_contracts/Scarb.toml → ...tarted/calling_other_contracts/Scarb.toml
diff --git a/.../calling_other_contracts/src/callee.cairo → .../calling_other_contracts/src/callee.cairo b/.../calling_other_contracts/src/callee.cairo → .../calling_other_contracts/src/callee.cairo
diff --git a/.../calling_other_contracts/src/caller.cairo → .../calling_other_contracts/src/caller.cairo b/.../calling_other_contracts/src/caller.cairo → .../calling_other_contracts/src/caller.cairo
diff --git a/...ion/calling_other_contracts/src/lib.cairo → ...ted/calling_other_contracts/src/lib.cairo b/...ion/calling_other_contracts/src/lib.cairo → ...ted/calling_other_contracts/src/lib.cairo
diff --git a/...n/calling_other_contracts/src/tests.cairo → ...d/calling_other_contracts/src/tests.cairo b/...n/calling_other_contracts/src/tests.cairo → ...d/calling_other_contracts/src/tests.cairo
diff --git a/.../ch00-introduction/constructor/.gitignore → ...00-getting-started/constructor/.gitignore b/.../ch00-introduction/constructor/.gitignore → ...00-getting-started/constructor/.gitignore
diff --git a/.../ch00-introduction/constructor/Scarb.toml → ...00-getting-started/constructor/Scarb.toml b/.../ch00-introduction/constructor/Scarb.toml → ...00-getting-started/constructor/Scarb.toml
diff --git a/...duction/constructor/src/constructor.cairo → ...started/constructor/src/constructor.cairo b/...duction/constructor/src/constructor.cairo → ...started/constructor/src/constructor.cairo
diff --git a/...00-introduction/constructor/src/lib.cairo → ...getting-started/constructor/src/lib.cairo b/...00-introduction/constructor/src/lib.cairo → ...getting-started/constructor/src/lib.cairo
diff --git a/...-introduction/constructor/src/tests.cairo → ...tting-started/constructor/src/tests.cairo b/...-introduction/constructor/src/tests.cairo → ...tting-started/constructor/src/tests.cairo
diff --git a/...ings/ch00-introduction/counter/.gitignore → ...s/ch00-getting-started/counter/.gitignore b/...ings/ch00-introduction/counter/.gitignore → ...s/ch00-getting-started/counter/.gitignore
diff --git a/...ings/ch00-introduction/counter/Scarb.toml → ...s/ch00-getting-started/counter/Scarb.toml b/...ings/ch00-introduction/counter/Scarb.toml → ...s/ch00-getting-started/counter/Scarb.toml
diff --git a/...00-introduction/counter/src/counter.cairo → ...getting-started/counter/src/counter.cairo b/...00-introduction/counter/src/counter.cairo → ...getting-started/counter/src/counter.cairo
diff --git a/...s/ch00-introduction/counter/src/lib.cairo → ...h00-getting-started/counter/src/lib.cairo b/...s/ch00-introduction/counter/src/lib.cairo → ...h00-getting-started/counter/src/lib.cairo
diff --git a/...ch00-introduction/counter/src/tests.cairo → ...0-getting-started/counter/src/tests.cairo b/...ch00-introduction/counter/src/tests.cairo → ...0-getting-started/counter/src/tests.cairo
diff --git a/...introduction/custom_type_serde/.gitignore → ...ting-started/custom_type_serde/.gitignore b/...introduction/custom_type_serde/.gitignore → ...ting-started/custom_type_serde/.gitignore
diff --git a/...introduction/custom_type_serde/Scarb.toml → ...ting-started/custom_type_serde/Scarb.toml b/...introduction/custom_type_serde/Scarb.toml → ...ting-started/custom_type_serde/Scarb.toml
diff --git a/...tion/custom_type_serde/src/contract.cairo → ...rted/custom_type_serde/src/contract.cairo b/...tion/custom_type_serde/src/contract.cairo → ...rted/custom_type_serde/src/contract.cairo
diff --git a/...roduction/custom_type_serde/src/lib.cairo → ...g-started/custom_type_serde/src/lib.cairo b/...roduction/custom_type_serde/src/lib.cairo → ...g-started/custom_type_serde/src/lib.cairo
diff --git a/...duction/custom_type_serde/src/tests.cairo → ...started/custom_type_serde/src/tests.cairo b/...duction/custom_type_serde/src/tests.cairo → ...started/custom_type_serde/src/tests.cairo
diff --git a/listings/ch00-introduction/errors/.gitignore → ...gs/ch00-getting-started/errors/.gitignore b/listings/ch00-introduction/errors/.gitignore → ...gs/ch00-getting-started/errors/.gitignore
diff --git a/listings/ch00-introduction/errors/Scarb.toml → ...gs/ch00-getting-started/errors/Scarb.toml b/listings/ch00-introduction/errors/Scarb.toml → ...gs/ch00-getting-started/errors/Scarb.toml
diff --git a/...troduction/errors/src/custom_errors.cairo → ...ng-started/errors/src/custom_errors.cairo b/...troduction/errors/src/custom_errors.cairo → ...ng-started/errors/src/custom_errors.cairo
diff --git a/...gs/ch00-introduction/errors/src/lib.cairo → ...ch00-getting-started/errors/src/lib.cairo b/...gs/ch00-introduction/errors/src/lib.cairo → ...ch00-getting-started/errors/src/lib.cairo
diff --git a/...troduction/errors/src/simple_errors.cairo → ...ng-started/errors/src/simple_errors.cairo b/...troduction/errors/src/simple_errors.cairo → ...ng-started/errors/src/simple_errors.cairo
diff --git a/.../ch00-introduction/errors/src/tests.cairo → ...00-getting-started/errors/src/tests.cairo b/.../ch00-introduction/errors/src/tests.cairo → ...00-getting-started/errors/src/tests.cairo
diff --git a/...ntroduction/errors/src/vault_errors.cairo → ...ing-started/errors/src/vault_errors.cairo b/...ntroduction/errors/src/vault_errors.cairo → ...ing-started/errors/src/vault_errors.cairo
diff --git a/listings/ch00-introduction/events/.gitignore → ...gs/ch00-getting-started/events/.gitignore b/listings/ch00-introduction/events/.gitignore → ...gs/ch00-getting-started/events/.gitignore
diff --git a/listings/ch00-introduction/events/Scarb.toml → ...gs/ch00-getting-started/events/Scarb.toml b/listings/ch00-introduction/events/Scarb.toml → ...gs/ch00-getting-started/events/Scarb.toml
diff --git a/...h00-introduction/events/src/counter.cairo → ...-getting-started/events/src/counter.cairo b/...h00-introduction/events/src/counter.cairo → ...-getting-started/events/src/counter.cairo
diff --git a/...gs/ch00-introduction/events/src/lib.cairo → ...ch00-getting-started/events/src/lib.cairo b/...gs/ch00-introduction/events/src/lib.cairo → ...ch00-getting-started/events/src/lib.cairo
diff --git a/.../ch00-introduction/events/src/tests.cairo → ...00-getting-started/events/src/tests.cairo b/.../ch00-introduction/events/src/tests.cairo → ...00-getting-started/events/src/tests.cairo
diff --git a/...introduction/interfaces_traits/.gitignore → ...ting-started/interfaces_traits/.gitignore b/...introduction/interfaces_traits/.gitignore → ...ting-started/interfaces_traits/.gitignore
diff --git a/...introduction/interfaces_traits/Scarb.toml → ...ting-started/interfaces_traits/Scarb.toml b/...introduction/interfaces_traits/Scarb.toml → ...ting-started/interfaces_traits/Scarb.toml
diff --git a/...tion/interfaces_traits/src/explicit.cairo → ...rted/interfaces_traits/src/explicit.cairo b/...tion/interfaces_traits/src/explicit.cairo → ...rted/interfaces_traits/src/explicit.cairo
diff --git a/...tion/interfaces_traits/src/implicit.cairo → ...rted/interfaces_traits/src/implicit.cairo b/...tion/interfaces_traits/src/implicit.cairo → ...rted/interfaces_traits/src/implicit.cairo
diff --git a/...rfaces_traits/src/implicit_internal.cairo → ...rfaces_traits/src/implicit_internal.cairo b/...rfaces_traits/src/implicit_internal.cairo → ...rfaces_traits/src/implicit_internal.cairo
diff --git a/...roduction/interfaces_traits/src/lib.cairo → ...g-started/interfaces_traits/src/lib.cairo b/...roduction/interfaces_traits/src/lib.cairo → ...g-started/interfaces_traits/src/lib.cairo
diff --git a/...duction/interfaces_traits/src/tests.cairo → ...started/interfaces_traits/src/tests.cairo b/...duction/interfaces_traits/src/tests.cairo → ...started/interfaces_traits/src/tests.cairo
diff --git a/...ngs/ch00-introduction/mappings/.gitignore → .../ch00-getting-started/mappings/.gitignore b/...ngs/ch00-introduction/mappings/.gitignore → .../ch00-getting-started/mappings/.gitignore
diff --git a/...ngs/ch00-introduction/mappings/Scarb.toml → .../ch00-getting-started/mappings/Scarb.toml b/...ngs/ch00-introduction/mappings/Scarb.toml → .../ch00-getting-started/mappings/Scarb.toml
diff --git a/.../ch00-introduction/mappings/src/lib.cairo → ...00-getting-started/mappings/src/lib.cairo b/.../ch00-introduction/mappings/src/lib.cairo → ...00-getting-started/mappings/src/lib.cairo
diff --git a/...-introduction/mappings/src/mappings.cairo → ...tting-started/mappings/src/mappings.cairo b/...-introduction/mappings/src/mappings.cairo → ...tting-started/mappings/src/mappings.cairo
diff --git a/...h00-introduction/mappings/src/tests.cairo → ...-getting-started/mappings/src/tests.cairo b/...h00-introduction/mappings/src/tests.cairo → ...-getting-started/mappings/src/tests.cairo
diff --git a/...roduction/storing_custom_types/.gitignore → ...g-started/storing_custom_types/.gitignore b/...roduction/storing_custom_types/.gitignore → ...g-started/storing_custom_types/.gitignore
diff --git a/...roduction/storing_custom_types/Scarb.toml → ...g-started/storing_custom_types/Scarb.toml b/...roduction/storing_custom_types/Scarb.toml → ...g-started/storing_custom_types/Scarb.toml
diff --git a/...n/storing_custom_types/src/contract.cairo → ...d/storing_custom_types/src/contract.cairo b/...n/storing_custom_types/src/contract.cairo → ...d/storing_custom_types/src/contract.cairo
diff --git a/...uction/storing_custom_types/src/lib.cairo → ...tarted/storing_custom_types/src/lib.cairo b/...uction/storing_custom_types/src/lib.cairo → ...tarted/storing_custom_types/src/lib.cairo
diff --git a/...tion/storing_custom_types/src/tests.cairo → ...rted/storing_custom_types/src/tests.cairo b/...tion/storing_custom_types/src/tests.cairo → ...rted/storing_custom_types/src/tests.cairo
diff --git a/...ings/ch00-introduction/testing/.gitignore → ...s/ch00-getting-started/testing/.gitignore b/...ings/ch00-introduction/testing/.gitignore → ...s/ch00-getting-started/testing/.gitignore
diff --git a/...ings/ch00-introduction/testing/Scarb.toml → ...s/ch00-getting-started/testing/Scarb.toml b/...ings/ch00-introduction/testing/Scarb.toml → ...s/ch00-getting-started/testing/Scarb.toml
diff --git a/...0-introduction/testing/src/contract.cairo → ...etting-started/testing/src/contract.cairo b/...0-introduction/testing/src/contract.cairo → ...etting-started/testing/src/contract.cairo
diff --git a/...s/ch00-introduction/testing/src/lib.cairo → ...h00-getting-started/testing/src/lib.cairo b/...s/ch00-introduction/testing/src/lib.cairo → ...h00-getting-started/testing/src/lib.cairo
diff --git a/...ch00-introduction/testing/src/tests.cairo → ...0-getting-started/testing/src/tests.cairo b/...ch00-introduction/testing/src/tests.cairo → ...0-getting-started/testing/src/tests.cairo
diff --git a/...gs/ch00-introduction/variables/.gitignore → ...ch00-getting-started/variables/.gitignore b/...gs/ch00-introduction/variables/.gitignore → ...ch00-getting-started/variables/.gitignore
diff --git a/...gs/ch00-introduction/variables/Scarb.toml → ...ch00-getting-started/variables/Scarb.toml b/...gs/ch00-introduction/variables/Scarb.toml → ...ch00-getting-started/variables/Scarb.toml
diff --git a/...tion/variables/src/global_variables.cairo → ...rted/variables/src/global_variables.cairo b/...tion/variables/src/global_variables.cairo → ...rted/variables/src/global_variables.cairo
diff --git a/...ch00-introduction/variables/src/lib.cairo → ...0-getting-started/variables/src/lib.cairo b/...ch00-introduction/variables/src/lib.cairo → ...0-getting-started/variables/src/lib.cairo
diff --git a/...ction/variables/src/local_variables.cairo → ...arted/variables/src/local_variables.cairo b/...ction/variables/src/local_variables.cairo → ...arted/variables/src/local_variables.cairo
diff --git a/...ion/variables/src/storage_variables.cairo → ...ted/variables/src/storage_variables.cairo b/...ion/variables/src/storage_variables.cairo → ...ted/variables/src/storage_variables.cairo
diff --git a/...00-introduction/variables/src/tests.cairo → ...getting-started/variables/src/tests.cairo b/...00-introduction/variables/src/tests.cairo → ...getting-started/variables/src/tests.cairo
diff --git a/...s/ch00-introduction/visibility/.gitignore → ...h00-getting-started/visibility/.gitignore b/...s/ch00-introduction/visibility/.gitignore → ...h00-getting-started/visibility/.gitignore
diff --git a/...s/ch00-introduction/visibility/Scarb.toml → ...h00-getting-started/visibility/Scarb.toml b/...s/ch00-introduction/visibility/Scarb.toml → ...h00-getting-started/visibility/Scarb.toml
diff --git a/...h00-introduction/visibility/src/lib.cairo → ...-getting-started/visibility/src/lib.cairo b/...h00-introduction/visibility/src/lib.cairo → ...-getting-started/visibility/src/lib.cairo
diff --git a/...0-introduction/visibility/src/tests.cairo → ...etting-started/visibility/src/tests.cairo b/...0-introduction/visibility/src/tests.cairo → ...etting-started/visibility/src/tests.cairo
diff --git a/...roduction/visibility/src/visibility.cairo → ...g-started/visibility/src/visibility.cairo b/...roduction/visibility/src/visibility.cairo → ...g-started/visibility/src/visibility.cairo
diff --git a/...vanced-concepts/storing_arrays/.gitignore → ...ch01-applications/simple_vault/.gitignore b/...vanced-concepts/storing_arrays/.gitignore → ...ch01-applications/simple_vault/.gitignore
diff --git a/...ch02-applications/simple_vault/Scarb.toml → ...ch01-applications/simple_vault/Scarb.toml b/...ch02-applications/simple_vault/Scarb.toml → ...ch01-applications/simple_vault/Scarb.toml
diff --git a/...2-applications/simple_vault/src/lib.cairo → ...1-applications/simple_vault/src/lib.cairo b/...2-applications/simple_vault/src/lib.cairo → ...1-applications/simple_vault/src/lib.cairo
diff --git a/...tions/simple_vault/src/simple_vault.cairo → ...tions/simple_vault/src/simple_vault.cairo b/...tions/simple_vault/src/simple_vault.cairo → ...tions/simple_vault/src/simple_vault.cairo
diff --git a/...applications/simple_vault/src/tests.cairo → ...applications/simple_vault/src/tests.cairo b/...applications/simple_vault/src/tests.cairo → ...applications/simple_vault/src/tests.cairo
diff --git a/...ced-concepts/write_to_any_slot/.gitignore → ...lications/upgradeable_contract/.gitignore b/...ced-concepts/write_to_any_slot/.gitignore → ...lications/upgradeable_contract/.gitignore
diff --git a/...lications/upgradeable_contract/Scarb.toml → ...lications/upgradeable_contract/Scarb.toml b/...lications/upgradeable_contract/Scarb.toml → ...lications/upgradeable_contract/Scarb.toml
diff --git a/...ations/upgradeable_contract/src/lib.cairo → ...ations/upgradeable_contract/src/lib.cairo b/...ations/upgradeable_contract/src/lib.cairo → ...ations/upgradeable_contract/src/lib.cairo
diff --git a/...ions/upgradeable_contract/src/tests.cairo → ...ions/upgradeable_contract/src/tests.cairo b/...ions/upgradeable_contract/src/tests.cairo → ...ions/upgradeable_contract/src/tests.cairo
diff --git a/...ontract/src/upgradeable_contract_v0.cairo → ...ontract/src/upgradeable_contract_v0.cairo b/...ontract/src/upgradeable_contract_v0.cairo → ...ontract/src/upgradeable_contract_v0.cairo
diff --git a/...ontract/src/upgradeable_contract_v1.cairo → ...ontract/src/upgradeable_contract_v1.cairo b/...ontract/src/upgradeable_contract_v1.cairo → ...ontract/src/upgradeable_contract_v1.cairo
diff --git a/...ch02-applications/simple_vault/.gitignore → ...d-concepts/store_using_packing/.gitignore b/...ch02-applications/simple_vault/.gitignore → ...d-concepts/store_using_packing/.gitignore
diff --git a/...imisations/store_using_packing/Scarb.toml → ...d-concepts/store_using_packing/Scarb.toml b/...imisations/store_using_packing/Scarb.toml → ...d-concepts/store_using_packing/Scarb.toml
diff --git a/...ns/store_using_packing/src/contract.cairo → ...ts/store_using_packing/src/contract.cairo b/...ns/store_using_packing/src/contract.cairo → ...ts/store_using_packing/src/contract.cairo
diff --git a/...ced-concepts/storing_arrays/src/lib.cairo → ...oncepts/store_using_packing/src/lib.cairo b/...ced-concepts/storing_arrays/src/lib.cairo → ...oncepts/store_using_packing/src/lib.cairo
diff --git a/...tions/store_using_packing/src/tests.cairo → ...cepts/store_using_packing/src/tests.cairo b/...tions/store_using_packing/src/tests.cairo → ...cepts/store_using_packing/src/tests.cairo
diff --git a/...lications/upgradeable_contract/.gitignore → ...vanced-concepts/storing_arrays/.gitignore b/...lications/upgradeable_contract/.gitignore → ...vanced-concepts/storing_arrays/.gitignore
diff --git a/...vanced-concepts/storing_arrays/Scarb.toml → ...vanced-concepts/storing_arrays/Scarb.toml b/...vanced-concepts/storing_arrays/Scarb.toml → ...vanced-concepts/storing_arrays/Scarb.toml
diff --git a/...oncepts/storing_arrays/src/contract.cairo → ...oncepts/storing_arrays/src/contract.cairo b/...oncepts/storing_arrays/src/contract.cairo → ...oncepts/storing_arrays/src/contract.cairo
diff --git a/...-concepts/write_to_any_slot/src/lib.cairo → ...ced-concepts/storing_arrays/src/lib.cairo b/...-concepts/write_to_any_slot/src/lib.cairo → ...ced-concepts/storing_arrays/src/lib.cairo
diff --git a/...d-concepts/storing_arrays/src/tests.cairo → ...d-concepts/storing_arrays/src/tests.cairo b/...d-concepts/storing_arrays/src/tests.cairo → ...d-concepts/storing_arrays/src/tests.cairo
diff --git a/...concepts/struct_as_mapping_key/.gitignore → ...concepts/struct_as_mapping_key/.gitignore b/...concepts/struct_as_mapping_key/.gitignore → ...concepts/struct_as_mapping_key/.gitignore
diff --git a/...concepts/struct_as_mapping_key/Scarb.toml → ...concepts/struct_as_mapping_key/Scarb.toml b/...concepts/struct_as_mapping_key/Scarb.toml → ...concepts/struct_as_mapping_key/Scarb.toml
diff --git a/.../struct_as_mapping_key/src/contract.cairo → .../struct_as_mapping_key/src/contract.cairo b/.../struct_as_mapping_key/src/contract.cairo → .../struct_as_mapping_key/src/contract.cairo
diff --git a/...cepts/struct_as_mapping_key/src/lib.cairo → ...cepts/struct_as_mapping_key/src/lib.cairo b/...cepts/struct_as_mapping_key/src/lib.cairo → ...cepts/struct_as_mapping_key/src/lib.cairo
diff --git a/...epts/struct_as_mapping_key/src/test.cairo → ...epts/struct_as_mapping_key/src/test.cairo b/...epts/struct_as_mapping_key/src/test.cairo → ...epts/struct_as_mapping_key/src/test.cairo
diff --git a/...imisations/store_using_packing/.gitignore → ...ced-concepts/write_to_any_slot/.gitignore b/...imisations/store_using_packing/.gitignore → ...ced-concepts/write_to_any_slot/.gitignore
diff --git a/...ced-concepts/write_to_any_slot/Scarb.toml → ...ced-concepts/write_to_any_slot/Scarb.toml b/...ced-concepts/write_to_any_slot/Scarb.toml → ...ced-concepts/write_to_any_slot/Scarb.toml
diff --git a/...epts/write_to_any_slot/src/contract.cairo → ...epts/write_to_any_slot/src/contract.cairo b/...epts/write_to_any_slot/src/contract.cairo → ...epts/write_to_any_slot/src/contract.cairo
diff --git a/...sations/store_using_packing/src/lib.cairo → ...-concepts/write_to_any_slot/src/lib.cairo b/...sations/store_using_packing/src/lib.cairo → ...-concepts/write_to_any_slot/src/lib.cairo
diff --git a/...oncepts/write_to_any_slot/src/tests.cairo → ...oncepts/write_to_any_slot/src/tests.cairo b/...oncepts/write_to_any_slot/src/tests.cairo → ...oncepts/write_to_any_slot/src/tests.cairo
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -1,33 +1,34 @@
 Summary
 
-- [Starknet by Example](./starknet-by-example.md)
-
-- [Basics of Smart Contracts in Cairo](./ch00/introduction.md)
-
-  - [Constructor](./ch00/constructor.md)
-  - [Visibility and Mutability](./ch00/visibility-mutability.md)
-  - [Events](./ch00/events.md)
-  - [Variables](./ch00/variables.md)
-  - [Mappings](./ch00/mappings.md)
-  - [Counter contract example](./ch00/counter.md)
-  - [Storing Custom Types](./ch00/storing-custom-types.md)
-  - [Custom types in entrypoints](./ch00/custom-types-in-entrypoints.md)
-  - [Errors](./ch00/errors.md)
-  - [Calling other contracts](./ch00/calling_other_contracts.md)
-  - [Contract interfaces and Traits generation](./ch00/interfaces-traits.md)
-  - [Contract testing](./ch00/contract-testing.md)
-
-- [Advanced concepts](./ch01/advanced-concepts.md)
-
-  - [Writing to any storage slot](./ch01/write_to_any_slot.md)
-  - [Storing Arrays](./ch01/storing_arrays.md)
-  - [Struct as mapping key](./ch01/struct-mapping-key.md)
-
-- [Applications](./ch02/applications.md)
-
-  - [Upgradeable Contract](./ch02/upgradeable_contract.md)
-  - [Defi Vault](./ch02/simple_vault.md)
-
-- [Optimisations](./ch03/optimisations.md)
-
-  - [Storage Optimisations](./ch03/store_using_packing.md)
+[Introduction](./starknet-by-example.md)
+
+<!-- ch00 -->
+# Getting Started
+  <!-- - [Local environnement setup](./ch00/env_setup.md) -->
+  - [Basics of a Starknet contract](./ch00/basics/introduction.md)
+    - [Variables](./ch00/basics/variables.md)
+    - [Constructor](./ch00/basics/constructor.md)
+    - [Visibility and Mutability](./ch00/basics/visibility-mutability.md)
+    - [Counter contract example](./ch00/basics/counter.md)
+    - [Mappings](./ch00/basics/mappings.md)
+    - [Errors](./ch00/basics/errors.md)
+    - [Events](./ch00/basics/events.md)
+    - [Storing Custom Types](./ch00/basics/storing-custom-types.md)
+    - [Custom types in entrypoints](./ch00/basics/custom-types-in-entrypoints.md)
+  - [Interfaces and interacting 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)
+  - [Testing contracts](./ch00/testing/contract-testing.md)
+
+<!-- ch01 -->
+# Applications examples
+  - [Upgradeable Contract](./ch01/upgradeable_contract.md)
+  - [Defi Vault](./ch01/simple_vault.md)
+
+<!-- ch02 -->
+# 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)
+  - [Optimisations](./ch02/optimisations/optimisations.md)
+    - [Storage Optimisations](./ch02/optimisations/store_using_packing.md)
diff --git a/src/ch00/constructor.md → src/ch00/basics/constructor.md b/src/ch00/constructor.md → src/ch00/basics/constructor.md
@@ -5,6 +5,6 @@ Constructors are a special type of function that runs only once when deploying a
 Here's a simple example that demonstrates how to initialize the state of a contract on deployment by defining logic inside a constructor.
 
 ```rust
-{{#include ../../listings/ch00-introduction/constructor/src/constructor.cairo}}
+{{#include ../../../listings/ch00-getting-started/constructor/src/constructor.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x017fd6558e67451dA583d123D77F4e2651E91502D08F8F8432355293b11e1f8F) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/constructor/src/constructor.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x017fd6558e67451dA583d123D77F4e2651E91502D08F8F8432355293b11e1f8F) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/constructor/src/constructor.cairo).
diff --git a/src/ch00/counter.md → src/ch00/basics/counter.md b/src/ch00/counter.md → src/ch00/basics/counter.md
@@ -11,6 +11,6 @@ Here's how it works:
 - When a user calls 'decrement', the contract decrements the counter by 1.
 
 ```rust
-{{#include ../../listings/ch00-introduction/counter/src/counter.cairo}}
+{{#include ../../../listings/ch00-getting-started/counter/src/counter.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x01664a69Fe701a1df7Bb0ae4A353792d0cf4E27146ee860075cbf6108b1D5718) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/counter/src/counter.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x01664a69Fe701a1df7Bb0ae4A353792d0cf4E27146ee860075cbf6108b1D5718) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/counter/src/counter.cairo).
diff --git a/src/ch00/custom-types-in-entrypoints.md → ...h00/basics/custom-types-in-entrypoints.md b/src/ch00/custom-types-in-entrypoints.md → ...h00/basics/custom-types-in-entrypoints.md
@@ -4,7 +4,7 @@ Using custom types in entrypoints requires our type to implement the `Serde` tra
 Thankfully, we can just derive the `Serde` trait for our custom type.
 
 ```rust
-{{#include ../../listings/ch00-introduction/custom_type_serde/src/contract.cairo}}
+{{#include ../../../listings/ch00-getting-started/custom_type_serde/src/contract.cairo}}
 ```
 
-Play with this contract in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/custom_type_serde/src/contract.cairo).
+Play with this contract in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/custom_type_serde/src/contract.cairo).
diff --git a/src/ch00/errors.md → src/ch00/basics/errors.md b/src/ch00/errors.md → src/ch00/basics/errors.md
@@ -16,24 +16,24 @@ To throw an error, use the `assert` or `panic` functions:
 Here's a simple example that demonstrates the use of these functions:
 
 ```rust
-{{#include ../../listings/ch00-introduction/errors/src/simple_errors.cairo}}
+{{#include ../../../listings/ch00-getting-started/errors/src/simple_errors.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x0022664463FF0b711CC9B549a9E87d65A0882bB1D29338C4108696B8F2216a40) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/errors/src/simple_errors.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x0022664463FF0b711CC9B549a9E87d65A0882bB1D29338C4108696B8F2216a40) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/errors/src/simple_errors.cairo).
 
 ## Custom errors
 
 You can make error handling easier by defining your error codes in a specific module.
 
 ```rust
-{{#include ../../listings/ch00-introduction/errors/src/custom_errors.cairo}}
+{{#include ../../../listings/ch00-getting-started/errors/src/custom_errors.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x0501CD5da5B453a18515B5A20b8029bd7583DFE7a399ad9f79c284F7829e4A57) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/errors/src/custom_errors.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x0501CD5da5B453a18515B5A20b8029bd7583DFE7a399ad9f79c284F7829e4A57) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/errors/src/custom_errors.cairo).
 
 ## Vault example
 
 Here's another example that demonstrates the use of errors in a more complex contract:
 
 ```rust
-{{#include ../../listings/ch00-introduction/errors/src/vault_errors.cairo}}
+{{#include ../../../listings/ch00-getting-started/errors/src/vault_errors.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x020C2da26F42A28Ef54ED428eF1810FE433784b055f9bF315C5d992b1579C268) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/errors/src/vault_errors.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x020C2da26F42A28Ef54ED428eF1810FE433784b055f9bF315C5d992b1579C268) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/errors/src/vault_errors.cairo).
diff --git a/src/ch00/events.md → src/ch00/basics/events.md b/src/ch00/events.md → src/ch00/basics/events.md
@@ -6,6 +6,6 @@ An event is defined as struct that derives the `#[starknet::Event]` trait. The f
 Here's a simple example of a contract using events that emit an event each time a counter is incremented by the "increment" function:
 
 ```rust
-{{#include ../../listings/ch00-introduction/events/src/counter.cairo}}
+{{#include ../../../listings/ch00-getting-started/events/src/counter.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x022e3B59518EA04aBb5da671ea04ecC3a154400f226d2Df38eFE146741b9E2F6) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/events/src/counter.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x022e3B59518EA04aBb5da671ea04ecC3a154400f226d2Df38eFE146741b9E2F6) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/events/src/counter.cairo).
diff --git a/src/ch00/introduction.md → src/ch00/basics/introduction.md b/src/ch00/introduction.md → src/ch00/basics/introduction.md
diff --git a/src/ch00/mappings.md → src/ch00/basics/mappings.md b/src/ch00/mappings.md → src/ch00/basics/mappings.md
@@ -11,6 +11,6 @@ Some additional notes:
 - In mappings, the address of the value at key `k_1,...,k_n` is `h(...h(h(sn_keccak(variable_name),k_1),k_2),...,k_n)` where `ℎ` is the Pedersen hash and the final value is taken `mod2251−256`. You can learn more about the contract storage layout in the [Starknet Documentation](https://docs.starknet.io/documentation/architecture_and_concepts/Contracts/contract-storage/#storage_variables)
 
 ```rust
-{{#include ../../listings/ch00-introduction/mappings/src/mappings.cairo}}
+{{#include ../../../listings/ch00-getting-started/mappings/src/mappings.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x06214AB4c23Cc545bf2221D465eB83aFb7412779AD498BD48a724B3F645E3505) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/mappings/src/mappings.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x06214AB4c23Cc545bf2221D465eB83aFb7412779AD498BD48a724B3F645E3505) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/mappings/src/mappings.cairo).
diff --git a/src/ch00/storing-custom-types.md → src/ch00/basics/storing-custom-types.md b/src/ch00/storing-custom-types.md → src/ch00/basics/storing-custom-types.md
@@ -3,7 +3,7 @@
 While native types can be stored in a contract's storage without any additional work, custom types require a bit more work. This is because at compile time, the compiler does not know how to store custom types in storage. To solve this, we need to implement the `Store` trait for our custom type. Hopefully, we can just derive this trait for our custom type - unless it contains arrays or dictionaries.
 
 ```rust
-{{#include ../../listings/ch00-introduction/storing_custom_types/src/contract.cairo}}
+{{#include ../../../listings/ch00-getting-started/storing_custom_types/src/contract.cairo}}
 ```
 
-Play with this contract in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/storing_custom_types/src/contract.cairo).
+Play with this contract in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/storing_custom_types/src/contract.cairo).
diff --git a/src/ch00/variables.md → src/ch00/basics/variables.md b/src/ch00/variables.md → src/ch00/basics/variables.md
@@ -21,9 +21,9 @@ Local variables are stored in memory and are not stored on the blockchain. This
 Here's a simple example of a contract with only local variables:
 
 ```rust
-{{#include ../../listings/ch00-introduction/variables/src/local_variables.cairo}}
+{{#include ../../../listings/ch00-getting-started/variables/src/local_variables.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x015B3a10F9689BeD741Ca3C210017BC097122CeF76f3cAA191A20ff8b9b56b96) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/variables/src/local_variables.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x015B3a10F9689BeD741Ca3C210017BC097122CeF76f3cAA191A20ff8b9b56b96) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/variables/src/local_variables.cairo).
 
 ## Storage Variables
 
@@ -36,9 +36,9 @@ On the other hand, you can read state variables, for free, without any transacti
 Here's a simple example of a contract with one storage variable:
 
 ```rust
-{{#include ../../listings/ch00-introduction/variables/src/storage_variables.cairo}}
+{{#include ../../../listings/ch00-getting-started/variables/src/storage_variables.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x06eA827B32875483709b785A7F9e846a52776Cd8D42C3fE696218c2624b0DCCa) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/variables/src/storage_variables.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x06eA827B32875483709b785A7F9e846a52776Cd8D42C3fE696218c2624b0DCCa) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/variables/src/storage_variables.cairo).
 
 ## Global Variables
 
@@ -49,6 +49,6 @@ In Starknet, you can access global variables by using specific functions contain
 For example, the `get_caller_address` function returns the address of the caller of the current transaction, and the `get_contract_address` function returns the address of the current contract.
 
 ```rust
-{{#include ../../listings/ch00-introduction/variables/src/global_variables.cairo}}
+{{#include ../../../listings/ch00-getting-started/variables/src/global_variables.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x05bD2F3943bd4e030f85678b55b2EC2C1be939e32388530FB20ED967B3Be433F) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/variables/src/global_variables.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x05bD2F3943bd4e030f85678b55b2EC2C1be939e32388530FB20ED967B3Be433F) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/variables/src/global_variables.cairo).
diff --git a/src/ch00/visibility-mutability.md → src/ch00/basics/visibility-mutability.md b/src/ch00/visibility-mutability.md → src/ch00/basics/visibility-mutability.md
@@ -25,6 +25,6 @@ Internal functions can't be called externally, but the same principle applies re
 Let's take a look at a simple example contract to see these in action:
 
 ```rust
-{{#include ../../listings/ch00-introduction/visibility/src/visibility.cairo}}
+{{#include ../../../listings/ch00-getting-started/visibility/src/visibility.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x0071dE3093AB58053b0292C225aa0eED40293e7694A0042685FF6D813d39889F) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/visibility/src/visibility.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x0071dE3093AB58053b0292C225aa0eED40293e7694A0042685FF6D813d39889F) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/visibility/src/visibility.cairo).
diff --git a/src/ch00/env_setup.md b/src/ch00/env_setup.md
@@ -0,0 +1,5 @@
+# Local environnement setup
+
+The current version of this book use `{{#include ../../.tool-versions}}`
+
+<!-- TODO -->
diff --git a/src/ch00/calling_other_contracts.md → ...00/interacting/calling_other_contracts.md b/src/ch00/calling_other_contracts.md → ...00/interacting/calling_other_contracts.md
@@ -10,11 +10,11 @@ The other way is to use the `starknet::call_contract_syscall` syscall yourself.
 In order to call other contracts using dispatchers, you will need to define the called contract's interface as a trait annotated with the `#[starknet::interface]` attribute, and then import the `IContractDispatcher` and `IContractDispatcherTrait` items in your contract.
 
 ```rust
-{{#include ../../listings/ch00-introduction/calling_other_contracts/src/callee.cairo}}
+{{#include ../../../listings/ch00-getting-started/calling_other_contracts/src/callee.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x015c3Bb6D0DE26b64FEAF9A8f4655CfADb5c128bF4510398972704ee12775DB1) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/calling_other_contracts/src/callee.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x015c3Bb6D0DE26b64FEAF9A8f4655CfADb5c128bF4510398972704ee12775DB1) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/calling_other_contracts/src/callee.cairo).
 
 ```rust
-{{#include ../../listings/ch00-introduction/calling_other_contracts/src/caller.cairo}}
+{{#include ../../../listings/ch00-getting-started/calling_other_contracts/src/caller.cairo}}
 ```
-Visit contract on [Voyager](https://goerli.voyager.online/contract/0x05fa8aF796343d2f22c53C17149386b67B7AC4aB52D9e308Aa507C185aA44778) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-introduction/calling_other_contracts/src/caller.cairo).
+Visit contract on [Voyager](https://goerli.voyager.online/contract/0x05fa8aF796343d2f22c53C17149386b67B7AC4aB52D9e308Aa507C185aA44778) or play with it in [Remix](https://remix.ethereum.org/?#activate=Starknet&url=https://github.com/NethermindEth/StarknetByExample/blob/main/listings/ch00-getting-started/calling_other_contracts/src/caller.cairo).
diff --git a/src/ch00/interacting/interacting.md b/src/ch00/interacting/interacting.md
@@ -0,0 +1,3 @@
+# Interacting with contracts
+
+In this chapter, we will see how to interact with contracts.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Interacting with contracts

		In this chapter, we will see how to interact with contracts.