diff --git a/.gitignore b/.gitignore index 7294be09..378eac25 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ build -book diff --git a/book.toml b/book.toml index 1e14847a..013d83ef 100644 --- a/book.toml +++ b/book.toml @@ -4,20 +4,25 @@ description = "First book about the Move programming language and the Move VM. M authors = ["Damir Shamanaev"] language = "en" multilingual = false -src = "src" +src = "book" repository = "damirka/move-book" +[build] +build-dir = "build" +extra-watch-dirs = ["packages"] # rebuild on Move Source changes + [output.html] additional-css = ["theme/css/custom.css"] git-repository-url = "https://github.com/MystenLabs/move-book" git-repository-icon = "fa-github" edit-url-template = "https://github.com/MystenLabs/move-book/edit/second-edition/{path}" +# Contains the redirects from the old book [output.html.redirect] -# optional = true "introduction/foreword" = "foreword" "introduction/getting-started" = "before-we-begin" +# syntax basics redirects "syntax-basics/index.html" = "/basic-syntax/index.html" "syntax-basics/concept.html" = "/basic-syntax/module.html" "syntax-basics/comments.html" = "/basic-syntax/comments.html" @@ -27,10 +32,10 @@ edit-url-template = "https://github.com/MystenLabs/move-book/edit/second-edition "syntax-basics/function.html" = "/basic-syntax/function.html" "advanced-topics/struct.html" = "/basic-syntax/struct.html" +# advanced topics redirects "advanced-topics/index.html" = "/programmability/index.html" -# TBD Redirects - +# TODO: "advanced-topics/types-with-abilities/index.html" = "/index.html" "advanced-topics/ownership-and-references.html" = "/index.html" "advanced-topics/understanding-generics.html" = "/index.html" @@ -45,7 +50,6 @@ edit-url-template = "https://github.com/MystenLabs/move-book/edit/second-edition "resources/resource-by-example/destroy-resource.html" = "/index.html" "resources/resource-by-example/furher-steps.html" = "/index.html" - "tutorials/index.html" = "/index.html" "tutorials/erc20.html" = "/index.html" "translations.html" = "/index.html" diff --git a/src/SUMMARY.md b/book/SUMMARY.md similarity index 100% rename from src/SUMMARY.md rename to book/SUMMARY.md diff --git a/src/appendix/acknowledgements.md b/book/appendix/acknowledgements.md similarity index 100% rename from src/appendix/acknowledgements.md rename to book/appendix/acknowledgements.md diff --git a/src/appendix/contributing.md b/book/appendix/contributing.md similarity index 100% rename from src/appendix/contributing.md rename to book/appendix/contributing.md diff --git a/src/appendix/glossary.md b/book/appendix/glossary.md similarity index 100% rename from src/appendix/glossary.md rename to book/appendix/glossary.md diff --git a/src/appendix/publications.md b/book/appendix/publications.md similarity index 100% rename from src/appendix/publications.md rename to book/appendix/publications.md diff --git a/src/appendix/references.md b/book/appendix/references.md similarity index 100% rename from src/appendix/references.md rename to book/appendix/references.md diff --git a/src/basic-syntax/README.md b/book/basic-syntax/README.md similarity index 100% rename from src/basic-syntax/README.md rename to book/basic-syntax/README.md diff --git a/src/basic-syntax/address.md b/book/basic-syntax/address.md similarity index 100% rename from src/basic-syntax/address.md rename to book/basic-syntax/address.md diff --git a/src/basic-syntax/assert-and-abort.md b/book/basic-syntax/assert-and-abort.md similarity index 100% rename from src/basic-syntax/assert-and-abort.md rename to book/basic-syntax/assert-and-abort.md diff --git a/src/basic-syntax/comments.md b/book/basic-syntax/comments.md similarity index 100% rename from src/basic-syntax/comments.md rename to book/basic-syntax/comments.md diff --git a/src/basic-syntax/constants.md b/book/basic-syntax/constants.md similarity index 100% rename from src/basic-syntax/constants.md rename to book/basic-syntax/constants.md diff --git a/src/basic-syntax/control-flow.md b/book/basic-syntax/control-flow.md similarity index 100% rename from src/basic-syntax/control-flow.md rename to book/basic-syntax/control-flow.md diff --git a/src/basic-syntax/copy-ability.md b/book/basic-syntax/copy-ability.md similarity index 100% rename from src/basic-syntax/copy-ability.md rename to book/basic-syntax/copy-ability.md diff --git a/src/basic-syntax/drop-ability.md b/book/basic-syntax/drop-ability.md similarity index 100% rename from src/basic-syntax/drop-ability.md rename to book/basic-syntax/drop-ability.md diff --git a/src/basic-syntax/expression.md b/book/basic-syntax/expression.md similarity index 100% rename from src/basic-syntax/expression.md rename to book/basic-syntax/expression.md diff --git a/src/basic-syntax/function.md b/book/basic-syntax/function.md similarity index 100% rename from src/basic-syntax/function.md rename to book/basic-syntax/function.md diff --git a/src/basic-syntax/generics.md b/book/basic-syntax/generics.md similarity index 100% rename from src/basic-syntax/generics.md rename to book/basic-syntax/generics.md diff --git a/src/basic-syntax/importing-modules.md b/book/basic-syntax/importing-modules.md similarity index 100% rename from src/basic-syntax/importing-modules.md rename to book/basic-syntax/importing-modules.md diff --git a/src/basic-syntax/module.md b/book/basic-syntax/module.md similarity index 100% rename from src/basic-syntax/module.md rename to book/basic-syntax/module.md diff --git a/src/basic-syntax/option.md b/book/basic-syntax/option.md similarity index 100% rename from src/basic-syntax/option.md rename to book/basic-syntax/option.md diff --git a/src/basic-syntax/ownership-and-scope.md b/book/basic-syntax/ownership-and-scope.md similarity index 100% rename from src/basic-syntax/ownership-and-scope.md rename to book/basic-syntax/ownership-and-scope.md diff --git a/src/basic-syntax/primitive-types.md b/book/basic-syntax/primitive-types.md similarity index 100% rename from src/basic-syntax/primitive-types.md rename to book/basic-syntax/primitive-types.md diff --git a/src/basic-syntax/references.md b/book/basic-syntax/references.md similarity index 100% rename from src/basic-syntax/references.md rename to book/basic-syntax/references.md diff --git a/src/basic-syntax/standard-library.md b/book/basic-syntax/standard-library.md similarity index 100% rename from src/basic-syntax/standard-library.md rename to book/basic-syntax/standard-library.md diff --git a/src/basic-syntax/string.md b/book/basic-syntax/string.md similarity index 100% rename from src/basic-syntax/string.md rename to book/basic-syntax/string.md diff --git a/src/basic-syntax/struct-methods.md b/book/basic-syntax/struct-methods.md similarity index 100% rename from src/basic-syntax/struct-methods.md rename to book/basic-syntax/struct-methods.md diff --git a/src/basic-syntax/struct.md b/book/basic-syntax/struct.md similarity index 100% rename from src/basic-syntax/struct.md rename to book/basic-syntax/struct.md diff --git a/src/basic-syntax/testing.md b/book/basic-syntax/testing.md similarity index 100% rename from src/basic-syntax/testing.md rename to book/basic-syntax/testing.md diff --git a/src/basic-syntax/type-reflection.md b/book/basic-syntax/type-reflection.md similarity index 100% rename from src/basic-syntax/type-reflection.md rename to book/basic-syntax/type-reflection.md diff --git a/src/basic-syntax/vector.md b/book/basic-syntax/vector.md similarity index 100% rename from src/basic-syntax/vector.md rename to book/basic-syntax/vector.md diff --git a/src/basic-syntax/visibility.md b/book/basic-syntax/visibility.md similarity index 100% rename from src/basic-syntax/visibility.md rename to book/basic-syntax/visibility.md diff --git a/src/before-we-begin/README.md b/book/before-we-begin/README.md similarity index 100% rename from src/before-we-begin/README.md rename to book/before-we-begin/README.md diff --git a/src/before-we-begin/ide-support.md b/book/before-we-begin/ide-support.md similarity index 100% rename from src/before-we-begin/ide-support.md rename to book/before-we-begin/ide-support.md diff --git a/src/before-we-begin/install-sui.md b/book/before-we-begin/install-sui.md similarity index 100% rename from src/before-we-begin/install-sui.md rename to book/before-we-begin/install-sui.md diff --git a/src/before-we-begin/move-2024.md b/book/before-we-begin/move-2024.md similarity index 100% rename from src/before-we-begin/move-2024.md rename to book/before-we-begin/move-2024.md diff --git a/src/concepts/README.md b/book/concepts/README.md similarity index 100% rename from src/concepts/README.md rename to book/concepts/README.md diff --git a/src/concepts/address.md b/book/concepts/address.md similarity index 100% rename from src/concepts/address.md rename to book/concepts/address.md diff --git a/src/concepts/manifest.md b/book/concepts/manifest.md similarity index 100% rename from src/concepts/manifest.md rename to book/concepts/manifest.md diff --git a/src/concepts/modules.md b/book/concepts/modules.md similarity index 100% rename from src/concepts/modules.md rename to book/concepts/modules.md diff --git a/src/concepts/object-model.md b/book/concepts/object-model.md similarity index 100% rename from src/concepts/object-model.md rename to book/concepts/object-model.md diff --git a/src/concepts/packages.md b/book/concepts/packages.md similarity index 100% rename from src/concepts/packages.md rename to book/concepts/packages.md diff --git a/src/concepts/user-interaction.md b/book/concepts/user-interaction.md similarity index 100% rename from src/concepts/user-interaction.md rename to book/concepts/user-interaction.md diff --git a/src/concepts/what-is-a-transaction.md b/book/concepts/what-is-a-transaction.md similarity index 100% rename from src/concepts/what-is-a-transaction.md rename to book/concepts/what-is-a-transaction.md diff --git a/src/concepts/what-is-an-account.md b/book/concepts/what-is-an-account.md similarity index 77% rename from src/concepts/what-is-an-account.md rename to book/concepts/what-is-an-account.md index 7bfd7f3c..71b17162 100644 --- a/src/concepts/what-is-an-account.md +++ b/book/concepts/what-is-an-account.md @@ -17,6 +17,6 @@ An account is a way to identify a user. An account is generated from a private key, and is identified by an address. An account can own objects, and can send transactions. Every transaction has a sender, and the sender is identified by an [address](./address.md). -Sui supports multiple cryptographic algorithms for account generation. The supported two curves are ed25519, secp256k1, there is also a special way of generating an account - zklogin. The cryptographic agility - the unique feature of Sui - allows for flexibility in the account generation. +Sui supports multiple cryptographic algorithms for account generation. The two supported curves are ed25519, secp256k1, and there is also a special way of generating an account - zklogin. The cryptographic agility - the unique feature of Sui - allows for flexibility in the account generation. diff --git a/src/foreword.md b/book/foreword.md similarity index 100% rename from src/foreword.md rename to book/foreword.md diff --git a/src/guides/2024-migration-guide.md b/book/guides/2024-migration-guide.md similarity index 100% rename from src/guides/2024-migration-guide.md rename to book/guides/2024-migration-guide.md diff --git a/src/guides/README.md b/book/guides/README.md similarity index 100% rename from src/guides/README.md rename to book/guides/README.md diff --git a/src/guides/better-error-handling.md b/book/guides/better-error-handling.md similarity index 100% rename from src/guides/better-error-handling.md rename to book/guides/better-error-handling.md diff --git a/src/guides/building-against-limits.md b/book/guides/building-against-limits.md similarity index 100% rename from src/guides/building-against-limits.md rename to book/guides/building-against-limits.md diff --git a/src/guides/debugging.md b/book/guides/debugging.md similarity index 100% rename from src/guides/debugging.md rename to book/guides/debugging.md diff --git a/src/guides/open-sourcing-libraries.md b/book/guides/open-sourcing-libraries.md similarity index 100% rename from src/guides/open-sourcing-libraries.md rename to book/guides/open-sourcing-libraries.md diff --git a/src/guides/testing.md b/book/guides/testing.md similarity index 100% rename from src/guides/testing.md rename to book/guides/testing.md diff --git a/src/guides/upgradeability-practices.md b/book/guides/upgradeability-practices.md similarity index 100% rename from src/guides/upgradeability-practices.md rename to book/guides/upgradeability-practices.md diff --git a/src/hello-sui/README.md b/book/hello-sui/README.md similarity index 100% rename from src/hello-sui/README.md rename to book/hello-sui/README.md diff --git a/src/hello-sui/hello-sui.md b/book/hello-sui/hello-sui.md similarity index 100% rename from src/hello-sui/hello-sui.md rename to book/hello-sui/hello-sui.md diff --git a/src/hello-sui/module-structure.md b/book/hello-sui/module-structure.md similarity index 100% rename from src/hello-sui/module-structure.md rename to book/hello-sui/module-structure.md diff --git a/src/history.md b/book/history.md similarity index 100% rename from src/history.md rename to book/history.md diff --git a/src/introduction.md b/book/introduction.md similarity index 100% rename from src/introduction.md rename to book/introduction.md diff --git a/src/object/README.md b/book/object/README.md similarity index 100% rename from src/object/README.md rename to book/object/README.md diff --git a/src/object/key-ability.md b/book/object/key-ability.md similarity index 100% rename from src/object/key-ability.md rename to book/object/key-ability.md diff --git a/src/object/shared-state.md b/book/object/shared-state.md similarity index 100% rename from src/object/shared-state.md rename to book/object/shared-state.md diff --git a/src/object/store-ability.md b/book/object/store-ability.md similarity index 100% rename from src/object/store-ability.md rename to book/object/store-ability.md diff --git a/src/object/transfer-restrictions.md b/book/object/transfer-restrictions.md similarity index 100% rename from src/object/transfer-restrictions.md rename to book/object/transfer-restrictions.md diff --git a/src/object/transfer-to-object.md b/book/object/transfer-to-object.md similarity index 100% rename from src/object/transfer-to-object.md rename to book/object/transfer-to-object.md diff --git a/src/object/true-ownership.md b/book/object/true-ownership.md similarity index 100% rename from src/object/true-ownership.md rename to book/object/true-ownership.md diff --git a/src/object/what-is-an-object.md b/book/object/what-is-an-object.md similarity index 100% rename from src/object/what-is-an-object.md rename to book/object/what-is-an-object.md diff --git a/src/programmability/README.md b/book/programmability/README.md similarity index 100% rename from src/programmability/README.md rename to book/programmability/README.md diff --git a/src/programmability/abstract-class.md b/book/programmability/abstract-class.md similarity index 100% rename from src/programmability/abstract-class.md rename to book/programmability/abstract-class.md diff --git a/src/programmability/authorization-patterns.md b/book/programmability/authorization-patterns.md similarity index 100% rename from src/programmability/authorization-patterns.md rename to book/programmability/authorization-patterns.md diff --git a/src/programmability/balance-and-coin.md b/book/programmability/balance-and-coin.md similarity index 100% rename from src/programmability/balance-and-coin.md rename to book/programmability/balance-and-coin.md diff --git a/src/programmability/bcs.md b/book/programmability/bcs.md similarity index 100% rename from src/programmability/bcs.md rename to book/programmability/bcs.md diff --git a/src/programmability/capability.md b/book/programmability/capability.md similarity index 100% rename from src/programmability/capability.md rename to book/programmability/capability.md diff --git a/src/programmability/collections.md b/book/programmability/collections.md similarity index 100% rename from src/programmability/collections.md rename to book/programmability/collections.md diff --git a/src/programmability/cryptography-and-hashing.md b/book/programmability/cryptography-and-hashing.md similarity index 100% rename from src/programmability/cryptography-and-hashing.md rename to book/programmability/cryptography-and-hashing.md diff --git a/src/programmability/display.md b/book/programmability/display.md similarity index 100% rename from src/programmability/display.md rename to book/programmability/display.md diff --git a/src/programmability/dynamic-collections.md b/book/programmability/dynamic-collections.md similarity index 100% rename from src/programmability/dynamic-collections.md rename to book/programmability/dynamic-collections.md diff --git a/src/programmability/dynamic-fields.md b/book/programmability/dynamic-fields.md similarity index 100% rename from src/programmability/dynamic-fields.md rename to book/programmability/dynamic-fields.md diff --git a/src/programmability/dynamic-object-fields.md b/book/programmability/dynamic-object-fields.md similarity index 100% rename from src/programmability/dynamic-object-fields.md rename to book/programmability/dynamic-object-fields.md diff --git a/src/programmability/epoch-and-time.md b/book/programmability/epoch-and-time.md similarity index 100% rename from src/programmability/epoch-and-time.md rename to book/programmability/epoch-and-time.md diff --git a/src/programmability/events.md b/book/programmability/events.md similarity index 100% rename from src/programmability/events.md rename to book/programmability/events.md diff --git a/src/programmability/fast-path.md b/book/programmability/fast-path.md similarity index 100% rename from src/programmability/fast-path.md rename to book/programmability/fast-path.md diff --git a/src/programmability/module-initializer.md b/book/programmability/module-initializer.md similarity index 100% rename from src/programmability/module-initializer.md rename to book/programmability/module-initializer.md diff --git a/src/programmability/one-time-witness.md b/book/programmability/one-time-witness.md similarity index 100% rename from src/programmability/one-time-witness.md rename to book/programmability/one-time-witness.md diff --git a/src/programmability/package-upgrades.md b/book/programmability/package-upgrades.md similarity index 100% rename from src/programmability/package-upgrades.md rename to book/programmability/package-upgrades.md diff --git a/src/programmability/publisher.md b/book/programmability/publisher.md similarity index 100% rename from src/programmability/publisher.md rename to book/programmability/publisher.md diff --git a/src/programmability/randomness.md b/book/programmability/randomness.md similarity index 100% rename from src/programmability/randomness.md rename to book/programmability/randomness.md diff --git a/src/programmability/sui-framework.md b/book/programmability/sui-framework.md similarity index 100% rename from src/programmability/sui-framework.md rename to book/programmability/sui-framework.md diff --git a/src/programmability/transaction-blocks.md b/book/programmability/transaction-blocks.md similarity index 100% rename from src/programmability/transaction-blocks.md rename to book/programmability/transaction-blocks.md diff --git a/src/programmability/transaction-context.md b/book/programmability/transaction-context.md similarity index 100% rename from src/programmability/transaction-context.md rename to book/programmability/transaction-context.md diff --git a/src/programmability/witness-and-abstract-implementation.md b/book/programmability/witness-and-abstract-implementation.md similarity index 100% rename from src/programmability/witness-and-abstract-implementation.md rename to book/programmability/witness-and-abstract-implementation.md diff --git a/src/programmability/witness-pattern.md b/book/programmability/witness-pattern.md similarity index 100% rename from src/programmability/witness-pattern.md rename to book/programmability/witness-pattern.md diff --git a/src/your-first-move.md b/book/your-first-move.md similarity index 100% rename from src/your-first-move.md rename to book/your-first-move.md diff --git a/src/your-first-move/README.md b/book/your-first-move/README.md similarity index 100% rename from src/your-first-move/README.md rename to book/your-first-move/README.md diff --git a/src/your-first-move/_hello-world.md b/book/your-first-move/_hello-world.md similarity index 100% rename from src/your-first-move/_hello-world.md rename to book/your-first-move/_hello-world.md diff --git a/src/your-first-move/adding-tests.md b/book/your-first-move/adding-tests.md similarity index 100% rename from src/your-first-move/adding-tests.md rename to book/your-first-move/adding-tests.md diff --git a/src/your-first-move/debugging.md b/book/your-first-move/debugging.md similarity index 100% rename from src/your-first-move/debugging.md rename to book/your-first-move/debugging.md diff --git a/src/your-first-move/generating-docs.md b/book/your-first-move/generating-docs.md similarity index 100% rename from src/your-first-move/generating-docs.md rename to book/your-first-move/generating-docs.md diff --git a/src/your-first-move/hello-world.md b/book/your-first-move/hello-world.md similarity index 100% rename from src/your-first-move/hello-world.md rename to book/your-first-move/hello-world.md diff --git a/src/your-first-move/publishing.md b/book/your-first-move/publishing.md similarity index 100% rename from src/your-first-move/publishing.md rename to book/your-first-move/publishing.md diff --git a/temp.publish.sh b/temp.publish.sh index a3194462..687425e1 100755 --- a/temp.publish.sh +++ b/temp.publish.sh @@ -11,4 +11,4 @@ mv book sui; git add sui; git commit -m "update $time"; git push origin head; -git checkout second-edition; +git checkout main;