From ddfaee6afbffacdc56ffd1a356e61af2066e2ca3 Mon Sep 17 00:00:00 2001 From: Christos Hadjiaslanis Date: Tue, 21 May 2024 20:09:03 +0100 Subject: [PATCH] Restructured docs to account for operators --- book.toml | 4 + linera-protocol | 2 +- src/SUMMARY.md | 92 +++++++++--------- src/developers.md | 3 + src/{ => developers}/advanced_topics.md | 0 .../advanced_topics/assets.md | 0 .../advanced_topics/block_creation.md | 0 .../advanced_topics/contract_finalize.md | 0 .../advanced_topics/persistent_storage.md | 0 .../advanced_topics/validators.md | 0 src/{ => developers}/advanced_topics/views.md | 0 src/{ => developers}/appendix.md | 0 src/{ => developers}/appendix/glossary.md | 0 src/{ => developers}/appendix/videos.md | 0 src/{ => developers}/core_concepts.md | 0 .../core_concepts/applications.md | 0 .../core_concepts/graphiql.png | Bin .../core_concepts/microchains.md | 0 .../core_concepts/node_service.md | 0 .../core_concepts/overview.md | 0 src/{ => developers}/core_concepts/wallets.md | 0 src/{ => developers}/experimental.md | 0 src/{ => developers}/experimental/ml.md | 0 src/{ => developers}/getting_started.md | 0 .../getting_started/hello_linera.md | 2 +- .../getting_started/installation.md | 12 +-- .../images/Linera-Header_1920x284px.svg | 0 src/{ => developers}/sdk.md | 0 src/{ => developers}/sdk/abi.md | 6 +- src/{ => developers}/sdk/composition.md | 4 +- src/{ => developers}/sdk/contract.md | 2 +- .../sdk/creating_a_project.md | 0 src/{ => developers}/sdk/deploy.md | 2 +- src/{ => developers}/sdk/logging.md | 0 src/{ => developers}/sdk/messages.md | 2 +- src/{ => developers}/sdk/service.md | 4 +- src/{ => developers}/sdk/state.md | 0 src/{ => developers}/sdk/testing.md | 0 src/introduction.md | 18 ++-- src/operators.md | 3 + src/operators/getting_started.md | 0 41 files changed, 87 insertions(+), 69 deletions(-) create mode 100644 src/developers.md rename src/{ => developers}/advanced_topics.md (100%) rename src/{ => developers}/advanced_topics/assets.md (100%) rename src/{ => developers}/advanced_topics/block_creation.md (100%) rename src/{ => developers}/advanced_topics/contract_finalize.md (100%) rename src/{ => developers}/advanced_topics/persistent_storage.md (100%) rename src/{ => developers}/advanced_topics/validators.md (100%) rename src/{ => developers}/advanced_topics/views.md (100%) rename src/{ => developers}/appendix.md (100%) rename src/{ => developers}/appendix/glossary.md (100%) rename src/{ => developers}/appendix/videos.md (100%) rename src/{ => developers}/core_concepts.md (100%) rename src/{ => developers}/core_concepts/applications.md (100%) rename src/{ => developers}/core_concepts/graphiql.png (100%) rename src/{ => developers}/core_concepts/microchains.md (100%) rename src/{ => developers}/core_concepts/node_service.md (100%) rename src/{ => developers}/core_concepts/overview.md (100%) rename src/{ => developers}/core_concepts/wallets.md (100%) rename src/{ => developers}/experimental.md (100%) rename src/{ => developers}/experimental/ml.md (100%) rename src/{ => developers}/getting_started.md (100%) rename src/{ => developers}/getting_started/hello_linera.md (99%) rename src/{ => developers}/getting_started/installation.md (88%) rename src/{ => developers}/images/Linera-Header_1920x284px.svg (100%) rename src/{ => developers}/sdk.md (100%) rename src/{ => developers}/sdk/abi.md (90%) rename src/{ => developers}/sdk/composition.md (96%) rename src/{ => developers}/sdk/contract.md (98%) rename src/{ => developers}/sdk/creating_a_project.md (100%) rename src/{ => developers}/sdk/deploy.md (97%) rename src/{ => developers}/sdk/logging.md (100%) rename src/{ => developers}/sdk/messages.md (98%) rename src/{ => developers}/sdk/service.md (97%) rename src/{ => developers}/sdk/state.md (100%) rename src/{ => developers}/sdk/testing.md (100%) create mode 100644 src/operators.md create mode 100644 src/operators/getting_started.md diff --git a/book.toml b/book.toml index 847e8852..dbb61e21 100644 --- a/book.toml +++ b/book.toml @@ -10,6 +10,10 @@ default-theme = "Light" default-dark-theme = "Ayu" additional-js = ["custom.js"] +[output.html.fold] +enable = true +level = 0 + [output.html.playground] runnable = false diff --git a/linera-protocol b/linera-protocol index 1b3b46f0..518b0a6e 160000 --- a/linera-protocol +++ b/linera-protocol @@ -1 +1 @@ -Subproject commit 1b3b46f0cd422607ed89e919a5ac24611fba8644 +Subproject commit 518b0a6e0097dbad2f6a23f8480884abf56900ee diff --git a/src/SUMMARY.md b/src/SUMMARY.md index aaa1a6d1..57924a35 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,49 +1,53 @@ # Summary -[The Linera Developer Manual](introduction.md) - -- [Getting Started](getting_started.md) - - - [Installation](getting_started/installation.md) - - [Hello, Linera](getting_started/hello_linera.md) - -- [The Linera Protocol](core_concepts.md) - - - [Overview](core_concepts/overview.md) - - [Microchains](core_concepts/microchains.md) - - [Wallets](core_concepts/wallets.md) - - [Node Service](core_concepts/node_service.md) - - [Applications](core_concepts/applications.md) - -- [Writing Linera Applications](sdk.md) - - - [Creating a Project](sdk/creating_a_project.md) - - [Creating the Application State](sdk/state.md) - - [Defining the ABI](sdk/abi.md) - - [Writing the Contract Binary](sdk/contract.md) - - [Writing the Service Binary](sdk/service.md) - - [Deploying the Application](sdk/deploy.md) - - [Cross-Chain Messages](sdk/messages.md) - - [Calling other Applications](sdk/composition.md) - - [Printing Logs from an Application](sdk/logging.md) - - [Writing Tests](sdk/testing.md) - -- [Advanced Topics](advanced_topics.md) - - - [Views](advanced_topics/views.md) - - [Persistent Storage](advanced_topics/persistent_storage.md) - - [Contract Finalization](advanced_topics/contract_finalize.md) - - [Validators](advanced_topics/validators.md) - - [Creating New Blocks](advanced_topics/block_creation.md) - - [Applications that Handle Assets](advanced_topics/assets.md) - -- [Experimental](experimental.md) - - - [Machine Learning](experimental/ml.md) - -- [Appendix](appendix.md) - - [Glossary](appendix/glossary.md) - - [Videos](appendix/videos.md) +[The Linera Manual](introduction.md) + +- [Developers](./developers.md) + + - [Getting Started](developers/getting_started.md) + + - [Installation](developers/getting_started/installation.md) + - [Hello, Linera](developers/getting_started/hello_linera.md) + + - [The Linera Protocol](developers/core_concepts.md) + + - [Overview](developers/core_concepts/overview.md) + - [Microchains](developers/core_concepts/microchains.md) + - [Wallets](developers/core_concepts/wallets.md) + - [Node Service](developers/core_concepts/node_service.md) + - [Applications](developers/core_concepts/applications.md) + + - [Writing Linera Applications](developers/sdk.md) + + - [Creating a Project](developers/sdk/creating_a_project.md) + - [Creating the Application State](developers/sdk/state.md) + - [Defining the ABI](developers/sdk/abi.md) + - [Writing the Contract Binary](developers/sdk/contract.md) + - [Writing the Service Binary](developers/sdk/service.md) + - [Deploying the Application](developers/sdk/deploy.md) + - [Cross-Chain Messages](developers/sdk/messages.md) + - [Calling other Applications](developers/sdk/composition.md) + - [Printing Logs from an Application](developers/sdk/logging.md) + - [Writing Tests](developers/sdk/testing.md) + + - [Advanced Topics](developers/advanced_topics.md) + + - [Views](developers/advanced_topics/views.md) + - [Persistent Storage](developers/advanced_topics/persistent_storage.md) + - [Contract Finalization](developers/advanced_topics/contract_finalize.md) + - [Validators](developers/advanced_topics/validators.md) + - [Creating New Blocks](developers/advanced_topics/block_creation.md) + - [Applications that Handle Assets](developers/advanced_topics/assets.md) + + - [Experimental](developers/experimental.md) + + - [Machine Learning](developers/experimental/ml.md) + + - [Appendix](developers/appendix.md) + - [Glossary](developers/appendix/glossary.md) + - [Videos](developers/appendix/videos.md) + +- [Operators](operators.md)