diff --git a/README.md b/README.md index 3cab52e308..a26aa5b55b 100644 --- a/README.md +++ b/README.md @@ -191,7 +191,7 @@ the redirection. There are three kinds of image assets used in the docs. 1. Screenshots, photos, non-technical figures go into `images/` folder - on the part-level (i.e. `docs/dapp/images`). External repositories may use + on the part-level (i.e. `docs/build/images`). External repositories may use own images in their respective folder. 2. [Mermaid](https://mermaid-js.github.io) diagrams (preferred tool for sequence diagrams, flowcharts and other technical material) live in diff --git a/docs/README.mdx b/docs/README.mdx index e9d3ecd2f8..3de730fb2b 100644 --- a/docs/README.mdx +++ b/docs/README.mdx @@ -17,7 +17,7 @@ chains and how to use unique Oasis features. findSidebarItem('/general/manage-tokens/cli/'), ]} /> -## Create dApp +## Build Contains learning material for the smart contract developers. Since the Oasis platform is best known for confidentiality, the most notable ParaTime is @@ -30,16 +30,16 @@ The part also covers other ParaTimes such as the non-confidential [Oasis Emerald] and Wasm-compatible, confidential [Oasis Cipher]. -[Oasis Sapphire]: dapp/sapphire/README.mdx -[Oasis Privacy Layer]: dapp/opl/README.mdx -[Oasis Emerald]: dapp/tools/other-paratimes/emerald/README.mdx -[Oasis Cipher]: dapp/tools/other-paratimes/cipher/README.mdx +[Oasis Sapphire]: ./build/sapphire/README.mdx +[Oasis Privacy Layer]: ./build/opl/README.mdx +[Oasis Emerald]: ./build/tools/other-paratimes/emerald/README.mdx +[Oasis Cipher]: ./build/tools/other-paratimes/cipher/README.mdx ## Build ROFL @@ -48,7 +48,7 @@ offchain in a trusted environment (TEE) and that seamlessly communicate with Oasis Sapphire. This is ideal for trusted oracles, compute-expensive tasks in AI or as a backend for interactive games. - + ## Get Involved @@ -83,7 +83,7 @@ Apart from the Sapphire, Emerald, Cipher and the Key manager ParaTimes, you can also write, compile, sign and deploy your own ParaTime on the Oasis Network. This part describes the knobs you need to use to do so. - + ## Develop Core diff --git a/docs/dapp/README.mdx b/docs/build/README.mdx similarity index 90% rename from docs/dapp/README.mdx rename to docs/build/README.mdx index 02ed080015..5b061bf944 100644 --- a/docs/dapp/README.mdx +++ b/docs/build/README.mdx @@ -6,7 +6,7 @@ import DocCard from '@theme/DocCard'; import DocCardList from '@theme/DocCardList'; import {findSidebarItem} from '@site/src/sidebarUtils'; -# Create dApp +# Build ![Oasis architectural design including ParaTime and consensus layers](../general/images/architecture/technology_scalability.svg) @@ -19,7 +19,7 @@ write both confidential and non-confidential smart contracts. For an overview of the other ParaTimes, refer to the [Other ParaTimes] chapter. [Oasis architecture]: ../general/oasis-network/README.mdx -[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/README.mdx +[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/build/sapphire/README.mdx [Other ParaTimes]: ./tools/other-paratimes/README.mdx ## Oasis Privacy Layer @@ -34,7 +34,16 @@ integrating bridges and wrapping the OpenZeppelin ERC2771 contract on top of Sapphire, demonstrates best practices for writing confidential smart contracts and working examples for you to explore and extend. - + + +## ROFL + +Runtime OFfchain Logic (ROFL) enables you to build secure applications running +offchain in a trusted environment (TEE) and that seamlessly communicate with +Oasis Sapphire. This is ideal for trusted oracles, compute-expensive tasks +in AI or as a backend for interactive games. + + ## Consensus Layer RPC Endpoints @@ -72,7 +81,7 @@ Public gRPC endpoints (in alphabetic order): | Name (Provider) | Mainnet URL | Testnet URL | |----------------------------------------------|---------------------------|-------------------------------| -| Oasis Scan ([Bit Cat]) | https://www.oasisscan.com | https://testnet.oasisscan.com | +| Oasis Scan ([Bit Cat]) | `https://www.oasisscan.com` | `https://testnet.oasisscan.com` | | Oasis Explorer ([Oasis Protocol Foundation]) | *Coming soon* | *Coming soon* | [Bit Cat]: https://www.bitcat365.com/ diff --git a/docs/dapp/diagrams/opl-contract-flow.mmd b/docs/build/diagrams/opl-contract-flow.mmd similarity index 100% rename from docs/dapp/diagrams/opl-contract-flow.mmd rename to docs/build/diagrams/opl-contract-flow.mmd diff --git a/docs/dapp/diagrams/opl-contract-flow.mmd.svg b/docs/build/diagrams/opl-contract-flow.mmd.svg similarity index 100% rename from docs/dapp/diagrams/opl-contract-flow.mmd.svg rename to docs/build/diagrams/opl-contract-flow.mmd.svg diff --git a/docs/dapp/diagrams/opl-router-pingpong-flow.mmd b/docs/build/diagrams/opl-router-pingpong-flow.mmd similarity index 100% rename from docs/dapp/diagrams/opl-router-pingpong-flow.mmd rename to docs/build/diagrams/opl-router-pingpong-flow.mmd diff --git a/docs/dapp/diagrams/opl-router-pingpong-flow.mmd.svg b/docs/build/diagrams/opl-router-pingpong-flow.mmd.svg similarity index 100% rename from docs/dapp/diagrams/opl-router-pingpong-flow.mmd.svg rename to docs/build/diagrams/opl-router-pingpong-flow.mmd.svg diff --git a/docs/dapp/images/emerald/block_explorer1.png b/docs/build/images/emerald/block_explorer1.png similarity index 100% rename from docs/dapp/images/emerald/block_explorer1.png rename to docs/build/images/emerald/block_explorer1.png diff --git a/docs/dapp/images/emerald/block_explorer2.png b/docs/build/images/emerald/block_explorer2.png similarity index 100% rename from docs/dapp/images/emerald/block_explorer2.png rename to docs/build/images/emerald/block_explorer2.png diff --git a/docs/dapp/images/emerald/oasisscan1.png b/docs/build/images/emerald/oasisscan1.png similarity index 100% rename from docs/dapp/images/emerald/oasisscan1.png rename to docs/build/images/emerald/oasisscan1.png diff --git a/docs/dapp/images/emerald/oasisscan2.png b/docs/build/images/emerald/oasisscan2.png similarity index 100% rename from docs/dapp/images/emerald/oasisscan2.png rename to docs/build/images/emerald/oasisscan2.png diff --git a/docs/dapp/images/opl/celer-architecture.png b/docs/build/images/opl/celer-architecture.png similarity index 100% rename from docs/dapp/images/opl/celer-architecture.png rename to docs/build/images/opl/celer-architecture.png diff --git a/docs/dapp/images/opl/celer-e2e.png b/docs/build/images/opl/celer-e2e.png similarity index 100% rename from docs/dapp/images/opl/celer-e2e.png rename to docs/build/images/opl/celer-e2e.png diff --git a/docs/dapp/images/opl/compile-pingpong.png b/docs/build/images/opl/compile-pingpong.png similarity index 100% rename from docs/dapp/images/opl/compile-pingpong.png rename to docs/build/images/opl/compile-pingpong.png diff --git a/docs/dapp/images/opl/confirm-new-poll.png b/docs/build/images/opl/confirm-new-poll.png similarity index 100% rename from docs/dapp/images/opl/confirm-new-poll.png rename to docs/build/images/opl/confirm-new-poll.png diff --git a/docs/dapp/images/opl/create-poll.png b/docs/build/images/opl/create-poll.png similarity index 100% rename from docs/dapp/images/opl/create-poll.png rename to docs/build/images/opl/create-poll.png diff --git a/docs/dapp/images/opl/past-dao-proposals.png b/docs/build/images/opl/past-dao-proposals.png similarity index 100% rename from docs/dapp/images/opl/past-dao-proposals.png rename to docs/build/images/opl/past-dao-proposals.png diff --git a/docs/dapp/images/opl/privacy-layer-diagram.png b/docs/build/images/opl/privacy-layer-diagram.png similarity index 100% rename from docs/dapp/images/opl/privacy-layer-diagram.png rename to docs/build/images/opl/privacy-layer-diagram.png diff --git a/docs/dapp/images/opl/router-approve.png b/docs/build/images/opl/router-approve.png similarity index 100% rename from docs/dapp/images/opl/router-approve.png rename to docs/build/images/opl/router-approve.png diff --git a/docs/dapp/images/opl/router-architecture.png b/docs/build/images/opl/router-architecture.png similarity index 100% rename from docs/dapp/images/opl/router-architecture.png rename to docs/build/images/opl/router-architecture.png diff --git a/docs/dapp/images/opl/router-deploy-pingpong-amoy.png b/docs/build/images/opl/router-deploy-pingpong-amoy.png similarity index 100% rename from docs/dapp/images/opl/router-deploy-pingpong-amoy.png rename to docs/build/images/opl/router-deploy-pingpong-amoy.png diff --git a/docs/dapp/images/opl/router-deploy-pingpong-sapphire.png b/docs/build/images/opl/router-deploy-pingpong-sapphire.png similarity index 100% rename from docs/dapp/images/opl/router-deploy-pingpong-sapphire.png rename to docs/build/images/opl/router-deploy-pingpong-sapphire.png diff --git a/docs/dapp/images/opl/router-faucet.png b/docs/build/images/opl/router-faucet.png similarity index 100% rename from docs/dapp/images/opl/router-faucet.png rename to docs/build/images/opl/router-faucet.png diff --git a/docs/dapp/images/opl/router-iping.png b/docs/build/images/opl/router-iping.png similarity index 100% rename from docs/dapp/images/opl/router-iping.png rename to docs/build/images/opl/router-iping.png diff --git a/docs/dapp/images/opl/router-metadata.png b/docs/build/images/opl/router-metadata.png similarity index 100% rename from docs/dapp/images/opl/router-metadata.png rename to docs/build/images/opl/router-metadata.png diff --git a/docs/dapp/images/opl/vote-on-ballot.png b/docs/build/images/opl/vote-on-ballot.png similarity index 100% rename from docs/dapp/images/opl/vote-on-ballot.png rename to docs/build/images/opl/vote-on-ballot.png diff --git a/docs/dapp/images/remix/remix01.png b/docs/build/images/remix/remix01.png similarity index 100% rename from docs/dapp/images/remix/remix01.png rename to docs/build/images/remix/remix01.png diff --git a/docs/dapp/images/remix/remix02.png b/docs/build/images/remix/remix02.png similarity index 100% rename from docs/dapp/images/remix/remix02.png rename to docs/build/images/remix/remix02.png diff --git a/docs/dapp/images/remix/remix03.png b/docs/build/images/remix/remix03.png similarity index 100% rename from docs/dapp/images/remix/remix03.png rename to docs/build/images/remix/remix03.png diff --git a/docs/dapp/images/remix/remix04.png b/docs/build/images/remix/remix04.png similarity index 100% rename from docs/dapp/images/remix/remix04.png rename to docs/build/images/remix/remix04.png diff --git a/docs/dapp/images/remix/sourcify.png b/docs/build/images/remix/sourcify.png similarity index 100% rename from docs/dapp/images/remix/sourcify.png rename to docs/build/images/remix/sourcify.png diff --git a/docs/dapp/images/tools/abi_playground_import.png b/docs/build/images/tools/abi_playground_import.png similarity index 100% rename from docs/dapp/images/tools/abi_playground_import.png rename to docs/build/images/tools/abi_playground_import.png diff --git a/docs/dapp/images/tools/abi_playground_load.png b/docs/build/images/tools/abi_playground_load.png similarity index 100% rename from docs/dapp/images/tools/abi_playground_load.png rename to docs/build/images/tools/abi_playground_load.png diff --git a/docs/dapp/images/tools/abi_playground_localnet.png b/docs/build/images/tools/abi_playground_localnet.png similarity index 100% rename from docs/dapp/images/tools/abi_playground_localnet.png rename to docs/build/images/tools/abi_playground_localnet.png diff --git a/docs/dapp/images/tools/band_demooracle_smartcontract.png b/docs/build/images/tools/band_demooracle_smartcontract.png similarity index 100% rename from docs/dapp/images/tools/band_demooracle_smartcontract.png rename to docs/build/images/tools/band_demooracle_smartcontract.png diff --git a/docs/dapp/images/tools/band_deploy_demooracle_smartcontact.png b/docs/build/images/tools/band_deploy_demooracle_smartcontact.png similarity index 100% rename from docs/dapp/images/tools/band_deploy_demooracle_smartcontact.png rename to docs/build/images/tools/band_deploy_demooracle_smartcontact.png diff --git a/docs/dapp/images/tools/band_get_rates.png b/docs/build/images/tools/band_get_rates.png similarity index 100% rename from docs/dapp/images/tools/band_get_rates.png rename to docs/build/images/tools/band_get_rates.png diff --git a/docs/dapp/images/tools/band_saveprice.png b/docs/build/images/tools/band_saveprice.png similarity index 100% rename from docs/dapp/images/tools/band_saveprice.png rename to docs/build/images/tools/band_saveprice.png diff --git a/docs/dapp/images/tools/explorer_abi_playground.png b/docs/build/images/tools/explorer_abi_playground.png similarity index 100% rename from docs/dapp/images/tools/explorer_abi_playground.png rename to docs/build/images/tools/explorer_abi_playground.png diff --git a/docs/dapp/images/tools/sourcify1.png b/docs/build/images/tools/sourcify1.png similarity index 100% rename from docs/dapp/images/tools/sourcify1.png rename to docs/build/images/tools/sourcify1.png diff --git a/docs/dapp/images/tools/sourcify2.png b/docs/build/images/tools/sourcify2.png similarity index 100% rename from docs/dapp/images/tools/sourcify2.png rename to docs/build/images/tools/sourcify2.png diff --git a/docs/dapp/images/tools/sourcify3.png b/docs/build/images/tools/sourcify3.png similarity index 100% rename from docs/dapp/images/tools/sourcify3.png rename to docs/build/images/tools/sourcify3.png diff --git a/docs/dapp/opl/README.mdx b/docs/build/opl/README.mdx similarity index 87% rename from docs/dapp/opl/README.mdx rename to docs/build/opl/README.mdx index 3329dc90e6..7043b83a2c 100644 --- a/docs/dapp/opl/README.mdx +++ b/docs/build/opl/README.mdx @@ -22,7 +22,7 @@ For more information about OPL and to catch the latest news, please visit the [official OPL page]. [official OPL page]: https://oasisprotocol.org/opl -[Sapphire]: ../sapphire/README.mdx +[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/build/sapphire/README.mdx ## How OPL Works @@ -40,7 +40,7 @@ messages, please visit our [Gasless Transactions chapter]. ::: -[Gasless Transactions chapter]: ../sapphire/gasless.md +[Gasless Transactions chapter]: https://github.com/oasisprotocol/docs/blob/main/docs/build/sapphire/develop/gasless.md ## Message Bridges @@ -65,9 +65,9 @@ enables seamless state transitions across multiple chains. ## Examples [OPL SDK]: ./opl-sdk/README.md diff --git a/docs/dapp/opl/celer/README.md b/docs/build/opl/celer/README.md similarity index 100% rename from docs/dapp/opl/celer/README.md rename to docs/build/opl/celer/README.md diff --git a/docs/dapp/opl/celer/networks.md b/docs/build/opl/celer/networks.md similarity index 100% rename from docs/dapp/opl/celer/networks.md rename to docs/build/opl/celer/networks.md diff --git a/docs/dapp/opl/celer/ping-example.md b/docs/build/opl/celer/ping-example.md similarity index 99% rename from docs/dapp/opl/celer/ping-example.md rename to docs/build/opl/celer/ping-example.md index ed8d7d44c5..ed8d15e100 100644 --- a/docs/dapp/opl/celer/ping-example.md +++ b/docs/build/opl/celer/ping-example.md @@ -22,7 +22,7 @@ The only prerequisite is a set-up Metamask account. If you're new to Remix, follow our basic guide for using Remix [here][dapp-remix]. -[dapp-remix]: /dapp/tools/remix.md +[dapp-remix]: ../../tools/remix.md ::: diff --git a/docs/dapp/opl/opl-sdk/README.md b/docs/build/opl/opl-sdk/README.md similarity index 100% rename from docs/dapp/opl/opl-sdk/README.md rename to docs/build/opl/opl-sdk/README.md diff --git a/docs/dapp/opl/opl-sdk/ping-example.md b/docs/build/opl/opl-sdk/ping-example.md similarity index 99% rename from docs/dapp/opl/opl-sdk/ping-example.md rename to docs/build/opl/opl-sdk/ping-example.md index 67eda476af..62ce792bdb 100644 --- a/docs/dapp/opl/opl-sdk/ping-example.md +++ b/docs/build/opl/opl-sdk/ping-example.md @@ -23,7 +23,7 @@ The only prerequisite is a set-up Metamask account. If you're new to Remix, follow our basic guide for using Remix [here][dapp-remix]. -[dapp-remix]: /dapp/tools/remix.md +[dapp-remix]: ../../tools/remix.md ::: diff --git a/docs/dapp/opl/router-protocol/README.md b/docs/build/opl/router-protocol/README.md similarity index 100% rename from docs/dapp/opl/router-protocol/README.md rename to docs/build/opl/router-protocol/README.md diff --git a/docs/dapp/opl/router-protocol/approve.md b/docs/build/opl/router-protocol/approve.md similarity index 100% rename from docs/dapp/opl/router-protocol/approve.md rename to docs/build/opl/router-protocol/approve.md diff --git a/docs/dapp/opl/router-protocol/interface.md b/docs/build/opl/router-protocol/interface.md similarity index 100% rename from docs/dapp/opl/router-protocol/interface.md rename to docs/build/opl/router-protocol/interface.md diff --git a/docs/dapp/opl/router-protocol/pingpong-example.md b/docs/build/opl/router-protocol/pingpong-example.md similarity index 99% rename from docs/dapp/opl/router-protocol/pingpong-example.md rename to docs/build/opl/router-protocol/pingpong-example.md index e0341605b7..eee165c06f 100644 --- a/docs/dapp/opl/router-protocol/pingpong-example.md +++ b/docs/build/opl/router-protocol/pingpong-example.md @@ -22,7 +22,7 @@ The only prerequisite is a set-up Metamask account. If you're new to Remix, follow our basic guide for using Remix [here][dapp-remix]. -[dapp-remix]: /dapp/tools/remix.md +[dapp-remix]: ../../tools/remix.md ::: @@ -281,7 +281,7 @@ For detailed instructions on fee payer approval, see our [approval guide]. [Router faucet]: https://faucet.routerprotocol.com/ [feepayer]: https://testnet.routerscan.io/feePayer -[approval guide]: /dapp/opl/router-protocol/approve +[approval guide]: ./approve.md ## Executing PingPong diff --git a/docs/rofl/README.mdx b/docs/build/rofl/README.mdx similarity index 91% rename from docs/rofl/README.mdx rename to docs/build/rofl/README.mdx index 44812b02ea..780d7154e2 100644 --- a/docs/rofl/README.mdx +++ b/docs/build/rofl/README.mdx @@ -22,8 +22,8 @@ This chapter will teach you how to build your own ROFL app with the help of the [Oasis Runtime SDK]. [Oasis Runtime SDK]: diff --git a/docs/build/rofl/app.mdx b/docs/build/rofl/app.mdx new file mode 120000 index 0000000000..8f79afe9b8 --- /dev/null +++ b/docs/build/rofl/app.mdx @@ -0,0 +1 @@ +../../../external/oasis-sdk/docs/rofl/app.mdx \ No newline at end of file diff --git a/docs/build/rofl/deployment.md b/docs/build/rofl/deployment.md new file mode 120000 index 0000000000..777f029b03 --- /dev/null +++ b/docs/build/rofl/deployment.md @@ -0,0 +1 @@ +../../../external/oasis-sdk/docs/rofl/deployment.md \ No newline at end of file diff --git a/docs/build/rofl/prerequisites.md b/docs/build/rofl/prerequisites.md new file mode 120000 index 0000000000..d057551c99 --- /dev/null +++ b/docs/build/rofl/prerequisites.md @@ -0,0 +1 @@ +../../../external/oasis-sdk/docs/rofl/prerequisites.md \ No newline at end of file diff --git a/docs/build/rofl/rofl.svg b/docs/build/rofl/rofl.svg new file mode 120000 index 0000000000..6ba8f00cbd --- /dev/null +++ b/docs/build/rofl/rofl.svg @@ -0,0 +1 @@ +../../../external/oasis-sdk/docs/rofl/rofl.svg \ No newline at end of file diff --git a/docs/build/rofl/trust-root.md b/docs/build/rofl/trust-root.md new file mode 120000 index 0000000000..c70f2a408a --- /dev/null +++ b/docs/build/rofl/trust-root.md @@ -0,0 +1 @@ +../../../external/oasis-sdk/docs/rofl/trust-root.md \ No newline at end of file diff --git a/docs/dapp/sapphire b/docs/build/sapphire similarity index 100% rename from docs/dapp/sapphire rename to docs/build/sapphire diff --git a/docs/dapp/tools/README.mdx b/docs/build/tools/README.mdx similarity index 72% rename from docs/dapp/tools/README.mdx rename to docs/build/tools/README.mdx index ffb1be2e34..927333b3d9 100644 --- a/docs/dapp/tools/README.mdx +++ b/docs/build/tools/README.mdx @@ -18,9 +18,9 @@ Oasis. ## See also diff --git a/docs/dapp/tools/abi-playground.md b/docs/build/tools/abi-playground.md similarity index 100% rename from docs/dapp/tools/abi-playground.md rename to docs/build/tools/abi-playground.md diff --git a/docs/dapp/tools/band.md b/docs/build/tools/band.md similarity index 100% rename from docs/dapp/tools/band.md rename to docs/build/tools/band.md diff --git a/docs/paratime/README.mdx b/docs/build/tools/build-paratime/README.mdx similarity index 64% rename from docs/paratime/README.mdx rename to docs/build/tools/build-paratime/README.mdx index cc96efa5e8..051f7f31b7 100644 --- a/docs/paratime/README.mdx +++ b/docs/build/tools/build-paratime/README.mdx @@ -11,10 +11,10 @@ This chapter will teach you how to build your own ParaTime with [Oasis Runtime SDK]. diff --git a/docs/build/tools/build-paratime/minimal-runtime.md b/docs/build/tools/build-paratime/minimal-runtime.md new file mode 120000 index 0000000000..d5680ee475 --- /dev/null +++ b/docs/build/tools/build-paratime/minimal-runtime.md @@ -0,0 +1 @@ +../../../../external/oasis-sdk/docs/runtime/minimal-runtime.md \ No newline at end of file diff --git a/docs/build/tools/build-paratime/modules.md b/docs/build/tools/build-paratime/modules.md new file mode 120000 index 0000000000..2436a1d220 --- /dev/null +++ b/docs/build/tools/build-paratime/modules.md @@ -0,0 +1 @@ +../../../../external/oasis-sdk/docs/runtime/modules.md \ No newline at end of file diff --git a/docs/build/tools/build-paratime/prerequisites.md b/docs/build/tools/build-paratime/prerequisites.md new file mode 120000 index 0000000000..3b7224569c --- /dev/null +++ b/docs/build/tools/build-paratime/prerequisites.md @@ -0,0 +1 @@ +../../../../external/oasis-sdk/docs/runtime/prerequisites.md \ No newline at end of file diff --git a/docs/build/tools/build-paratime/reproducibility.md b/docs/build/tools/build-paratime/reproducibility.md new file mode 120000 index 0000000000..2e8191aaaf --- /dev/null +++ b/docs/build/tools/build-paratime/reproducibility.md @@ -0,0 +1 @@ +../../../../external/oasis-sdk/docs/runtime/reproducibility.md \ No newline at end of file diff --git a/docs/dapp/tools/localnet.mdx b/docs/build/tools/localnet.mdx similarity index 100% rename from docs/dapp/tools/localnet.mdx rename to docs/build/tools/localnet.mdx diff --git a/docs/dapp/tools/other-paratimes/README.mdx b/docs/build/tools/other-paratimes/README.mdx similarity index 74% rename from docs/dapp/tools/other-paratimes/README.mdx rename to docs/build/tools/other-paratimes/README.mdx index 780fbb3c16..178d537750 100644 --- a/docs/dapp/tools/other-paratimes/README.mdx +++ b/docs/build/tools/other-paratimes/README.mdx @@ -16,7 +16,7 @@ Learn more by exploring the ParaTimes below! | | EVM-compatible | Oasis Wasm | |---------------------:|-------------------------------------------------------|-----------------------------------------------------| -| **Confidential** | | | -| **Non-Confidential** | | | +| **Confidential** | | | +| **Non-Confidential** | | | -[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/dapp/sapphire/README.mdx \ No newline at end of file +[Sapphire]: https://github.com/oasisprotocol/docs/blob/main/docs/build/sapphire/README.mdx diff --git a/docs/dapp/tools/other-paratimes/cipher/README.mdx b/docs/build/tools/other-paratimes/cipher/README.mdx similarity index 84% rename from docs/dapp/tools/other-paratimes/cipher/README.mdx rename to docs/build/tools/other-paratimes/cipher/README.mdx index c3261daa0d..53c25a41ac 100644 --- a/docs/dapp/tools/other-paratimes/cipher/README.mdx +++ b/docs/build/tools/other-paratimes/cipher/README.mdx @@ -38,15 +38,15 @@ confidential smart contract in Rust and deploy it on Cipher, read the related Oasis Contract SDK chapters: ## See also @@ -55,8 +55,8 @@ Oasis Contract SDK chapters: findSidebarItem('/general/manage-tokens/'), findSidebarItem('/node/run-your-node/paratime-node'), findSidebarItem('/node/run-your-node/paratime-client-node'), - findSidebarItem('/dapp/tools/other-paratimes/emerald/'), - findSidebarItem('/dapp/sapphire/'), + findSidebarItem('/build/tools/other-paratimes/emerald/'), + findSidebarItem('/build/sapphire/'), ]} /> [Oasis Contract SDK]: diff --git a/docs/dapp/tools/other-paratimes/cipher/confidential-smart-contract.md b/docs/build/tools/other-paratimes/cipher/confidential-smart-contract.md similarity index 100% rename from docs/dapp/tools/other-paratimes/cipher/confidential-smart-contract.md rename to docs/build/tools/other-paratimes/cipher/confidential-smart-contract.md diff --git a/docs/dapp/tools/other-paratimes/cipher/hello-world.md b/docs/build/tools/other-paratimes/cipher/hello-world.md similarity index 100% rename from docs/dapp/tools/other-paratimes/cipher/hello-world.md rename to docs/build/tools/other-paratimes/cipher/hello-world.md diff --git a/docs/dapp/tools/other-paratimes/cipher/network.mdx b/docs/build/tools/other-paratimes/cipher/network.mdx similarity index 99% rename from docs/dapp/tools/other-paratimes/cipher/network.mdx rename to docs/build/tools/other-paratimes/cipher/network.mdx index 2736d24f32..80037c9042 100644 --- a/docs/dapp/tools/other-paratimes/cipher/network.mdx +++ b/docs/build/tools/other-paratimes/cipher/network.mdx @@ -61,4 +61,4 @@ and wish to be added to these docs, open an issue at ::: -[github.com/oasisprotocol/docs]: https://github.com/oasisprotocol/docs \ No newline at end of file +[github.com/oasisprotocol/docs]: https://github.com/oasisprotocol/docs diff --git a/docs/dapp/tools/other-paratimes/cipher/prerequisites.md b/docs/build/tools/other-paratimes/cipher/prerequisites.md similarity index 100% rename from docs/dapp/tools/other-paratimes/cipher/prerequisites.md rename to docs/build/tools/other-paratimes/cipher/prerequisites.md diff --git a/docs/dapp/tools/other-paratimes/emerald/README.mdx b/docs/build/tools/other-paratimes/emerald/README.mdx similarity index 91% rename from docs/dapp/tools/other-paratimes/emerald/README.mdx rename to docs/build/tools/other-paratimes/emerald/README.mdx index ae0d0c73db..74fe1e3a62 100644 --- a/docs/dapp/tools/other-paratimes/emerald/README.mdx +++ b/docs/build/tools/other-paratimes/emerald/README.mdx @@ -33,6 +33,6 @@ See crucial network information [here][network]. findSidebarItem('/node/run-your-node/paratime-node'), findSidebarItem('/node/run-your-node/paratime-client-node'), findSidebarItem('/node/web3'), - findSidebarItem('/dapp/sapphire/'), - findSidebarItem('/dapp/tools/other-paratimes/cipher/'), + findSidebarItem('/build/sapphire/'), + findSidebarItem('/build/tools/other-paratimes/cipher/'), ]} /> diff --git a/docs/dapp/tools/other-paratimes/emerald/network.mdx b/docs/build/tools/other-paratimes/emerald/network.mdx similarity index 97% rename from docs/dapp/tools/other-paratimes/emerald/network.mdx rename to docs/build/tools/other-paratimes/emerald/network.mdx index 2657d50f78..c577442765 100644 --- a/docs/dapp/tools/other-paratimes/emerald/network.mdx +++ b/docs/build/tools/other-paratimes/emerald/network.mdx @@ -58,7 +58,7 @@ dedicated RPC endpoints, consider the following providers (in alphabetic order): | Name/Provider | Mainnet URL | Testnet URL | EIP-3091 compatible | |-----------------------------|-------------------------------------------|-------------------------------------------|---------------------| -| [Oasis Explorer][Oasis Protocol Foundation] | https://explorer.oasis.io/mainnet/emerald | https://explorer.oasis.io/testnet/emerald | Yes | +| [Oasis Explorer][Oasis Protocol Foundation] | `https://explorer.oasis.io/mainnet/emerald` | `https://explorer.oasis.io/testnet/emerald` | Yes | | Oasis Scan ([Bit Cat]) | [https://www.oasisscan.com/paratimes/000…87f](https://www.oasisscan.com/paratimes/000000000000000000000000000000000000000000000000e2eaa99fc008f87f) | [https://testnet.oasisscan.com/paratimes/000…ca7](https://testnet.oasisscan.com/paratimes/00000000000000000000000000000000000000000000000072c8215e60d5bca7) | No | [Bit Cat]: https://www.bitcat365.com/ diff --git a/docs/dapp/tools/other-paratimes/emerald/writing-dapps-on-emerald.mdx b/docs/build/tools/other-paratimes/emerald/writing-dapps-on-emerald.mdx similarity index 100% rename from docs/dapp/tools/other-paratimes/emerald/writing-dapps-on-emerald.mdx rename to docs/build/tools/other-paratimes/emerald/writing-dapps-on-emerald.mdx diff --git a/docs/dapp/tools/remix.md b/docs/build/tools/remix.md similarity index 93% rename from docs/dapp/tools/remix.md rename to docs/build/tools/remix.md index f3e2505efb..005b52f657 100644 --- a/docs/dapp/tools/remix.md +++ b/docs/build/tools/remix.md @@ -87,13 +87,13 @@ Note that Remix operates without a Sapphire client, meaning transactions and queries are unencrypted and unsigned by default. To make use of Sapphire's confidential features, refer to our [Quickstart Tutorial]. -[Quickstart Tutorial]: https://docs.oasis.io/dapp/sapphire/quickstart +[Quickstart Tutorial]: https://github.com/oasisprotocol/docs/blob/main/docs/build/sapphire/quickstart.mdx Should you have any questions, do not hesitate to share them with us on the [#dev-central Discord channel][discord]. [localnet]: ./localnet.mdx -[network page]: https://docs.oasis.io/dapp/sapphire/network#rpc-endpoints +[network page]: https://github.com/oasisprotocol/docs/blob/main/docs/build/sapphire/network.mdx#rpc-endpoints [Remix]: https://remix.ethereum.org [Remix documentation]: https://remix-ide.readthedocs.io/en/latest/ [metamask]: ../../general/manage-tokens/README.mdx#metamask diff --git a/docs/dapp/tools/verification.md b/docs/build/tools/verification.md similarity index 100% rename from docs/dapp/tools/verification.md rename to docs/build/tools/verification.md diff --git a/docs/general/manage-tokens/README.mdx b/docs/general/manage-tokens/README.mdx index 1013375be3..6859c5fba8 100644 --- a/docs/general/manage-tokens/README.mdx +++ b/docs/general/manage-tokens/README.mdx @@ -125,8 +125,8 @@ chapter. ![Metamask - Adding Sapphire Mainnet Network Configuration](../images/wallet/metamask/settings.png) [MetaMask]: https://metamask.io/download/ -[Sapphire]: ../../dapp/sapphire/network.mdx#rpc-endpoints -[Emerald]: ../../dapp/tools/other-paratimes/emerald/network.mdx#rpc-endpoints +[Sapphire]: ../../build/sapphire/network.mdx#rpc-endpoints +[Emerald]: ../../build/tools/other-paratimes/emerald/network.mdx#rpc-endpoints ### Ledger diff --git a/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md b/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md index 8666397aa2..8c1e2cd2d5 100644 --- a/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md +++ b/docs/general/manage-tokens/how-to-transfer-eth-erc20-to-emerald-paratime.md @@ -6,7 +6,7 @@ the Wormhole token bridge. ## About -[Emerald](/dapp/tools/other-paratimes/emerald/) is an Oasis ParaTime providing an Ethereum-compatible blockchain for the Oasis Network. If you want to use any dApp for DEX, NFT and similar built on Emerald, you will have to transfer your assets into the Emerald ParaTime. +[Emerald](../../build/tools/other-paratimes/emerald/) is an Oasis ParaTime providing an Ethereum-compatible blockchain for the Oasis Network. If you want to use any dApp for DEX, NFT and similar built on Emerald, you will have to transfer your assets into the Emerald ParaTime. To transfer your ROSE tokens into Emerald, read the [Manage tokens](README.mdx). @@ -93,6 +93,6 @@ Now you can start using that wrapped assets across new Oasis dApps like the firs :::info Make sure that your MetaMask is connected to the Emerald Mainnet chain. You -can find the network parameters [here](../../dapp/tools/other-paratimes/emerald/network.mdx#rpc-endpoints). +can find the network parameters [here](../../build/tools/other-paratimes/emerald/network.mdx#rpc-endpoints). ::: diff --git a/docs/node/mainnet/README.md b/docs/node/mainnet/README.md index 13c89e913e..ed45df9353 100644 --- a/docs/node/mainnet/README.md +++ b/docs/node/mainnet/README.md @@ -89,7 +89,7 @@ This section contains parameters for various ParaTimes known to be deployed on t :::info -Check the [Emerald ParaTime page](/dapp/tools/other-paratimes/emerald/network#rpc-endpoints) on how to access +Check the [Emerald ParaTime page](../../build/tools/other-paratimes/emerald/network#rpc-endpoints) on how to access the public Web3 endpoint. ::: diff --git a/docs/node/run-your-node/paratime-client-node.mdx b/docs/node/run-your-node/paratime-client-node.mdx index 401ed38ec5..263076b63c 100644 --- a/docs/node/run-your-node/paratime-client-node.mdx +++ b/docs/node/run-your-node/paratime-client-node.mdx @@ -98,7 +98,7 @@ Like the genesis document, make sure you obtain these from a trusted source. #### **Compiling the ParaTime Binary from Source Code** In case you decide to build the ParaTime binary from source yourself, make sure -that you follow our [guidelines for deterministic compilation](../../paratime/reproducibility) +that you follow our [guidelines for deterministic compilation](../../build/tools/build-paratime/reproducibility) to ensure that you receive the exact same binary. ::: diff --git a/docs/node/run-your-node/paratime-node.mdx b/docs/node/run-your-node/paratime-node.mdx index d2e78b360d..f21494851a 100644 --- a/docs/node/run-your-node/paratime-node.mdx +++ b/docs/node/run-your-node/paratime-node.mdx @@ -165,7 +165,7 @@ Like the genesis document, make sure you obtain these from a trusted source. #### **Compiling the ParaTime Binary from Source Code** In case you decide to build the ParaTime binary from source yourself, make sure -that you follow our [guidelines for deterministic compilation](../../paratime/reproducibility.md) +that you follow our [guidelines for deterministic compilation](../../build/tools/build-paratime/reproducibility.md) to ensure that you receive the exact same binary. When the ParaTime is running in a TEE, a different binary to what is registered diff --git a/docs/node/web3.mdx b/docs/node/web3.mdx index 897fda8003..7a1fcb1782 100644 --- a/docs/node/web3.mdx +++ b/docs/node/web3.mdx @@ -308,20 +308,20 @@ extended downtime while the Web3 Gateway is reindexing the blocks. ::: -[Emerald]: ../dapp/tools/other-paratimes/emerald/README.mdx +[Emerald]: ../build/tools/other-paratimes/emerald/README.mdx [Emerald Mainnet launch]: https://medium.com/oasis-protocol-project/oasis-emerald-evm-paratime-is-live-on-mainnet-13afe953a4c9 -[emerald-mainnet]: ../dapp/tools/other-paratimes/emerald/network.mdx -[emerald-testnet]: ../dapp/tools/other-paratimes/emerald/network.mdx +[emerald-mainnet]: ../build/tools/other-paratimes/emerald/network.mdx +[emerald-testnet]: ../build/tools/other-paratimes/emerald/network.mdx [github-releases]: https://github.com/oasisprotocol/oasis-web3-gateway/releases [Mainnet]: mainnet/README.md [mainnet-emerald]: mainnet/README.md#emerald [mainnet-sapphire]: mainnet/README.md#sapphire [Oasis archive node]: run-your-node/archive-node.md [README.md]: https://github.com/oasisprotocol/oasis-web3-gateway/blob/main/README.md#building-and-testing -[Sapphire]: ../dapp/sapphire/README.mdx -[sapphire-testnet]: ../dapp/sapphire/network.mdx -[sapphire-mainnet]: ../dapp/sapphire/network.mdx +[Sapphire]: ../build/sapphire/README.mdx +[sapphire-testnet]: ../build/sapphire/network.mdx +[sapphire-mainnet]: ../build/sapphire/network.mdx [system service]: run-your-node/prerequisites/system-configuration.mdx#create-a-user [Testnet]: testnet/README.md [testnet-emerald]: testnet/README.md#emerald diff --git a/docs/paratime/minimal-runtime.md b/docs/paratime/minimal-runtime.md deleted file mode 120000 index 4914bc38de..0000000000 --- a/docs/paratime/minimal-runtime.md +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/runtime/minimal-runtime.md \ No newline at end of file diff --git a/docs/paratime/modules.md b/docs/paratime/modules.md deleted file mode 120000 index 97c2e4aca9..0000000000 --- a/docs/paratime/modules.md +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/runtime/modules.md \ No newline at end of file diff --git a/docs/paratime/prerequisites.md b/docs/paratime/prerequisites.md deleted file mode 120000 index 3bdec2421e..0000000000 --- a/docs/paratime/prerequisites.md +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/runtime/prerequisites.md \ No newline at end of file diff --git a/docs/paratime/reproducibility.md b/docs/paratime/reproducibility.md deleted file mode 120000 index 1e981da94d..0000000000 --- a/docs/paratime/reproducibility.md +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/runtime/reproducibility.md \ No newline at end of file diff --git a/docs/rofl/app.mdx b/docs/rofl/app.mdx deleted file mode 120000 index b7dc40dd6e..0000000000 --- a/docs/rofl/app.mdx +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/rofl/app.mdx \ No newline at end of file diff --git a/docs/rofl/deployment.md b/docs/rofl/deployment.md deleted file mode 120000 index bbb1db9f0a..0000000000 --- a/docs/rofl/deployment.md +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/rofl/deployment.md \ No newline at end of file diff --git a/docs/rofl/prerequisites.md b/docs/rofl/prerequisites.md deleted file mode 120000 index 4de79acf45..0000000000 --- a/docs/rofl/prerequisites.md +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/rofl/prerequisites.md \ No newline at end of file diff --git a/docs/rofl/rofl.svg b/docs/rofl/rofl.svg deleted file mode 120000 index 08856b30e0..0000000000 --- a/docs/rofl/rofl.svg +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/rofl/rofl.svg \ No newline at end of file diff --git a/docs/rofl/trust-root.md b/docs/rofl/trust-root.md deleted file mode 120000 index 5b666d55c0..0000000000 --- a/docs/rofl/trust-root.md +++ /dev/null @@ -1 +0,0 @@ -../../external/oasis-sdk/docs/rofl/trust-root.md \ No newline at end of file diff --git a/docusaurus.config.ts b/docusaurus.config.ts index daf3dd5d88..b7cf4c3838 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -105,15 +105,9 @@ const config: Config = { position: 'left', }, { - label: 'Create dApp', - to: '/dapp/', - activeBaseRegex: '/dapp/', - position: 'left', - }, - { - label: 'Build ROFL', - to: '/rofl/', - activeBaseRegex: '/rofl/', + label: 'Build', + to: '/build/', + activeBaseRegex: '/build/', position: 'left', }, { @@ -128,12 +122,6 @@ const config: Config = { activeBaseRegex: '/node/', position: 'left', }, - { - label: 'Build ParaTime', - to: '/paratime/', - activeBaseRegex: '/paratime/', - position: 'left', - }, { label: 'Develop Core', to: '/core/', diff --git a/external/cli b/external/cli index 8a1f1979cf..2be96ec7c3 160000 --- a/external/cli +++ b/external/cli @@ -1 +1 @@ -Subproject commit 8a1f1979cf09a3d58ef9d5b9c24a1c0042b0ebaa +Subproject commit 2be96ec7c3a29b60893468945df54e129ef57ea6 diff --git a/external/oasis-sdk b/external/oasis-sdk index d21610ac66..d66ec038c1 160000 --- a/external/oasis-sdk +++ b/external/oasis-sdk @@ -1 +1 @@ -Subproject commit d21610ac662edff84560312508b6e3de82095f13 +Subproject commit d66ec038c1758ab2243cff72d82a0d6c07e74568 diff --git a/external/sapphire-paratime b/external/sapphire-paratime index 6c676278ef..ec901649e8 160000 --- a/external/sapphire-paratime +++ b/external/sapphire-paratime @@ -1 +1 @@ -Subproject commit 6c676278efcde88a4459617c53d3a865049614b9 +Subproject commit ec901649e83a8ee4a4c166a255d38d569086e8c0 diff --git a/redirects.ts b/redirects.ts index 2d151c30c5..cd9ca4fbd5 100644 --- a/redirects.ts +++ b/redirects.ts @@ -138,22 +138,25 @@ export const redirectsOptions: Options = { from: '/general/community-resources/token-delivery-and-kyc', // #200 Restructure docs }, { - to: '/dapp/', + to: '/build/', from: [ '/oasis-sdk/', // #200 Restructure docs '/general/developer-resources/overview' // #200 Restructure docs ], }, { - to: '/dapp/tools/other-paratimes/cipher/', + to: '/build/tools/other-paratimes/cipher/', from: '/oasis-sdk/contract/getting-started', // #200 Restructure docs }, { - to: '/dapp/sapphire/', - from: '/general/developer-resources/sapphire-paratime', // #200 Restructure docs + to: '/build/sapphire/', + from: [ + '/general/developer-resources/sapphire-paratime', // #200 Restructure docs + '/dapp/sapphire/', // #1058 Rename dapp to build + ] }, { - to: '/dapp/sapphire/quickstart', + to: '/build/sapphire/quickstart', from: [ '/general/developer-resources/sapphire-paratime/writing-dapps-on-sapphire', // #218 Add sapphire tutorial '/dapp/sapphire/writing-dapps-on-sapphire', // #218 Add sapphire tutorial @@ -272,7 +275,7 @@ export const redirectsOptions: Options = { from: '/general/foundation/testnet/upgrade-log', // #200 Restructure docs }, { - to: '/paratime/', + to: '/build/tools/build-paratime/', from: '/oasis-sdk/runtime/getting-started' // #200 Restructure docs }, { @@ -288,21 +291,29 @@ export const redirectsOptions: Options = { from: '/dapp/sapphire/precompiles' // #688 Migrate dapp/sapphire/precompiles chapter to api.docs.oasis.io }, { - to: '/dapp/tools/band', + to: '/build/tools/band', from: '/dapp/emerald/integrating-band-oracle-smart-contract', // #907 Move Band oracle to Tools section }, { - to: '/dapp/tools/verification', + to: '/build/tools/verification', from: '/dapp/sapphire/verification', // #1054 Move Sapphire verification to Tools section }, { - to: '/dapp/tools/other-paratimes/emerald/', + to: '/build/tools/other-paratimes/emerald/', from: '/dapp/emerald/', // #1041 Move Emerald and Cipher to /tools/other-paratimes/ }, { - to: '/dapp/tools/other-paratimes/cipher/', + to: '/build/tools/other-paratimes/cipher/', from: '/dapp/cipher/', // #1041 Move Emerald and Cipher to /tools/other-paratimes/ }, + { + to: '/build/rofl/', + from: '/rofl/', // #1058 Rename dapp to build + }, + { + to: '/build/tools/build-paratime/', + from: '/paratime/', // #1058 Rename dapp to build + }, ], createRedirects(existingPath) { // #119 Add /oasis-core/adr/* -> /adrs/* redirection diff --git a/sidebarBuild.ts b/sidebarBuild.ts new file mode 100644 index 0000000000..7987288ac8 --- /dev/null +++ b/sidebarBuild.ts @@ -0,0 +1,207 @@ +import {SidebarsConfig} from '@docusaurus/plugin-content-docs'; + +export const sidebarBuild: SidebarsConfig = { + developers: [ + { + type: 'doc', + label: 'Overview', + id: 'build/README', + }, + { + type: 'category', + label: 'Sapphire', + link: { + type: 'doc', + id: 'build/sapphire/README', + }, + items: [ + 'build/sapphire/quickstart', + 'build/sapphire/network', + 'build/sapphire/ethereum', + + { + type: 'category', + label: 'Develop', + link: { + type: 'doc', + id: 'build/sapphire/develop/README', + }, + items: [ + 'build/sapphire/develop/concept', + 'build/sapphire/develop/browser', + 'build/sapphire/develop/authentication', + 'build/sapphire/develop/gasless', + 'build/sapphire/develop/deployment', + 'build/sapphire/develop/security', + { + type: 'link', + label: 'TypeScript API', + href: 'https://api.docs.oasis.io/js/sapphire-paratime', + }, + { + type: 'link', + label: 'Solidity API', + href: 'https://api.docs.oasis.io/sol/sapphire-contracts', + }, + ], + }, + 'build/sapphire/testing', + 'build/sapphire/examples', + 'build/sapphire/addresses', + ], + collapsed: false + }, + { + type: 'category', + label: 'ROFL', + link: { + type: 'doc', + id: 'build/rofl/README', + }, + items: [ + 'build/rofl/prerequisites', + 'build/rofl/app', + { + type: 'doc', + label: 'Deployment', + id: 'build/rofl/deployment', + }, + 'build/rofl/trust-root', + ], + collapsed: false + }, + { + type: 'category', + label: 'Oasis Privacy Layer', + link: { + type: 'doc', + id: 'build/opl/README', + }, + items: [ + { + type: 'category', + label: 'OPL SDK', + link: { + type: 'doc', + id: 'build/opl/opl-sdk/README', + }, + items: [ + 'build/opl/opl-sdk/ping-example', + ], + }, + { + type: 'category', + label: 'Celer Inter-Chain Messaging', + link: { + type: 'doc', + id: 'build/opl/celer/README', + }, + items: [ + 'build/opl/celer/ping-example', + 'build/opl/celer/networks', + ], + }, + { + type: 'category', + label: 'Router Protocol', + link: { + type: 'doc', + id: 'build/opl/router-protocol/README', + }, + items: [ + 'build/opl/router-protocol/pingpong-example', + 'build/opl/router-protocol/interface', + 'build/opl/router-protocol/approve', + ], + }, + ], + collapsed: false + }, + { + type: 'category', + label: 'Tools & Services', + link: { + type: 'doc', + id: 'build/tools/README', + }, + items: [ + 'build/tools/abi-playground', + 'build/tools/verification', + 'build/tools/band', + 'build/tools/localnet', + 'build/tools/remix', + { + type: 'category', + label: 'Build Paratime', + link: { + type: 'doc', + id: 'build/tools/build-paratime/README' + }, + items: [ + 'build/tools/build-paratime/prerequisites', + 'build/tools/build-paratime/minimal-runtime', + 'build/tools/build-paratime/modules', + 'build/tools/build-paratime/reproducibility', + { + type: 'link', + label: 'ParaTime Client TypeScript API', + href: 'https://api.docs.oasis.io/js/client-rt', + }, + { + type: 'link', + label: 'ParaTime Client Go API', + href: 'https://pkg.go.dev/github.com/oasisprotocol/oasis-sdk/client-sdk/go/client', + }, + { + type: 'link', + label: 'ParaTime SDK Rust API', + href: 'https://api.docs.oasis.io/rust/oasis_runtime_sdk', + }, + ] + }, + { + type: 'category', + label: 'Other Paratimes', + link: { + type: 'doc', + id: 'build/tools/other-paratimes/README', + }, + items: [ + { + type: 'category', + label: 'Emerald', + link: { + type: 'doc', + id: 'build/tools/other-paratimes/emerald/README', + }, + items: [ + 'build/tools/other-paratimes/emerald/network', + 'build/tools/other-paratimes/emerald/writing-dapps-on-emerald', + ], + }, + { + type: 'category', + label: 'Cipher', + link: { + type: 'doc', + id: 'build/tools/other-paratimes/cipher/README', + }, + items: [ + 'build/tools/other-paratimes/cipher/prerequisites', + 'build/tools/other-paratimes/cipher/network', + 'build/tools/other-paratimes/cipher/hello-world', + 'build/tools/other-paratimes/cipher/confidential-smart-contract', + { + type: 'link', + label: 'Rust API', + href: 'https://api.docs.oasis.io/rust/oasis_contract_sdk', + }, + ], + } + ], + }, + ], + collapsed: false + }, + ], +}; diff --git a/sidebarDapp.ts b/sidebarDapp.ts deleted file mode 100644 index 8404dce4a9..0000000000 --- a/sidebarDapp.ts +++ /dev/null @@ -1,142 +0,0 @@ -import {SidebarsConfig} from '@docusaurus/plugin-content-docs'; - -export const sidebarDapp: SidebarsConfig = { - developers: [ - { - type: 'doc', - label: 'Overview', - id: 'dapp/README', - }, - { - type: 'category', - label: 'Sapphire', - link: { - type: 'doc', - id: 'dapp/sapphire/README', - }, - items: [ - 'dapp/sapphire/quickstart', - 'dapp/sapphire/network', - 'dapp/sapphire/guide', - 'dapp/sapphire/browser', - 'dapp/sapphire/authentication', - 'dapp/sapphire/gasless', - 'dapp/sapphire/addresses', - 'dapp/sapphire/deployment', - 'dapp/sapphire/security', - { - type: 'link', - label: 'TypeScript API', - href: 'https://api.docs.oasis.io/js/sapphire-paratime', - }, - { - type: 'link', - label: 'Solidity API', - href: 'https://api.docs.oasis.io/sol/sapphire-contracts', - }, - ], - }, - { - type: 'category', - label: 'Oasis Privacy Layer', - link: { - type: 'doc', - id: 'dapp/opl/README', - }, - items: [ - { - type: 'category', - label: 'OPL SDK', - link: { - type: 'doc', - id: 'dapp/opl/opl-sdk/README', - }, - items: [ - 'dapp/opl/opl-sdk/ping-example', - ], - }, - { - type: 'category', - label: 'Celer Inter-Chain Messaging', - link: { - type: 'doc', - id: 'dapp/opl/celer/README', - }, - items: [ - 'dapp/opl/celer/ping-example', - 'dapp/opl/celer/networks', - ], - }, - { - type: 'category', - label: 'Router Protocol', - link: { - type: 'doc', - id: 'dapp/opl/router-protocol/README', - }, - items: [ - 'dapp/opl/router-protocol/pingpong-example', - 'dapp/opl/router-protocol/interface', - 'dapp/opl/router-protocol/approve', - ], - }, - ], - }, - { - type: 'category', - label: 'Tools & Services', - link: { - type: 'doc', - id: 'dapp/tools/README', - }, - items: [ - 'dapp/tools/abi-playground', - 'dapp/tools/verification', - 'dapp/tools/band', - 'dapp/tools/localnet', - 'dapp/tools/remix', - { - type: 'category', - label: 'Other Paratimes', - link: { - type: 'doc', - id: 'dapp/tools/other-paratimes/README', - }, - items: [ - { - type: 'category', - label: 'Emerald', - link: { - type: 'doc', - id: 'dapp/tools/other-paratimes/emerald/README', - }, - items: [ - 'dapp/tools/other-paratimes/emerald/network', - 'dapp/tools/other-paratimes/emerald/writing-dapps-on-emerald', - ], - }, - { - type: 'category', - label: 'Cipher', - link: { - type: 'doc', - id: 'dapp/tools/other-paratimes/cipher/README', - }, - items: [ - 'dapp/tools/other-paratimes/cipher/prerequisites', - 'dapp/tools/other-paratimes/cipher/network', - 'dapp/tools/other-paratimes/cipher/hello-world', - 'dapp/tools/other-paratimes/cipher/confidential-smart-contract', - { - type: 'link', - label: 'Rust API', - href: 'https://api.docs.oasis.io/rust/oasis_contract_sdk', - }, - ], - } - ], - }, - ], - }, - ], -}; diff --git a/sidebarParatime.ts b/sidebarParatime.ts deleted file mode 100644 index dd26e3311c..0000000000 --- a/sidebarParatime.ts +++ /dev/null @@ -1,30 +0,0 @@ -import {SidebarsConfig} from '@docusaurus/plugin-content-docs'; - -export const sidebarParaTime: SidebarsConfig = { - paratime: [ - { - type: 'doc', - label: 'Overview', - id: 'paratime/README', - }, - 'paratime/prerequisites', - 'paratime/minimal-runtime', - 'paratime/modules', - 'paratime/reproducibility', - { - type: 'link', - label: 'ParaTime Client TypeScript API', - href: 'https://api.docs.oasis.io/js/client-rt', - }, - { - type: 'link', - label: 'ParaTime Client Go API', - href: 'https://pkg.go.dev/github.com/oasisprotocol/oasis-sdk/client-sdk/go/client', - }, - { - type: 'link', - label: 'ParaTime SDK Rust API', - href: 'https://api.docs.oasis.io/rust/oasis_runtime_sdk', - }, - ], -}; diff --git a/sidebarRofl.ts b/sidebarRofl.ts deleted file mode 100644 index f0ad984753..0000000000 --- a/sidebarRofl.ts +++ /dev/null @@ -1,19 +0,0 @@ -import {SidebarsConfig} from '@docusaurus/plugin-content-docs'; - -export const sidebarROFL: SidebarsConfig = { - rofl: [ - { - type: 'doc', - label: 'Overview', - id: 'rofl/README', - }, - 'rofl/prerequisites', - 'rofl/app', - { - type: 'doc', - label: 'Deployment', - id: 'rofl/deployment', - }, - 'rofl/trust-root', - ], -}; diff --git a/sidebars.ts b/sidebars.ts index 0e6781e1a9..856ed12a5e 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -2,22 +2,18 @@ import {SidebarsConfig} from '@docusaurus/plugin-content-docs'; import {sidebarAdrs} from './sidebarAdrs'; import {sidebarCore} from './sidebarCore'; -import {sidebarDapp} from './sidebarDapp'; +import {sidebarBuild} from './sidebarBuild'; import {sidebarGeneral} from './sidebarGeneral'; import {sidebarGetInvolved} from './sidebarGetInvolved'; import {sidebarNode} from './sidebarNode'; -import {sidebarParaTime} from './sidebarParatime'; -import {sidebarROFL} from './sidebarRofl'; const sidebars: SidebarsConfig = { ...sidebarAdrs, ...sidebarCore, - ...sidebarDapp, + ...sidebarBuild, ...sidebarGeneral, ...sidebarGetInvolved, ...sidebarNode, - ...sidebarParaTime, - ...sidebarROFL, }; export default sidebars; diff --git a/src/remark/cross-repo-links.ts b/src/remark/cross-repo-links.ts index 0c3507a688..01e87612bf 100644 --- a/src/remark/cross-repo-links.ts +++ b/src/remark/cross-repo-links.ts @@ -29,11 +29,11 @@ export default function plugin(): Transformer { function visitor(untypedNode: mdast.Node) { const node = untypedNode as mdast.Definition | mdast.Link if (oasisSdkContractRegex.test(node.url)) { - node.url = node.url.replace(oasisSdkContractRegex, '/dapp/tools/other-paratimes/cipher/$1$2'); + node.url = node.url.replace(oasisSdkContractRegex, '/build/tools/other-paratimes/cipher/$1$2'); } else if (oasisSdkRuntimeRegex.test(node.url)) { - node.url = node.url.replace(oasisSdkRuntimeRegex, '/paratime/$1$2'); + node.url = node.url.replace(oasisSdkRuntimeRegex, '/build/tools/build-paratime/$1$2'); } else if (oasisSdkRoflRegex.test(node.url)) { - node.url = node.url.replace(oasisSdkRoflRegex, '/rofl/$1$2'); + node.url = node.url.replace(oasisSdkRoflRegex, '/build/rofl/$1$2'); } else if (cliRegex.test(node.url)) { node.url = node.url.replace(cliRegex, '/general/manage-tokens/cli/$1$2'); } else if (oasisCoreRegex.test(node.url)) { @@ -41,7 +41,7 @@ export default function plugin(): Transformer { } else if (adrsRegex.test(node.url)) { node.url = node.url.replace(adrsRegex, '/adrs/$1$2'); } else if (sapphireParatimeRegex.test(node.url)) { - node.url = node.url.replace(sapphireParatimeRegex, '/dapp/sapphire/$1$2'); + node.url = node.url.replace(sapphireParatimeRegex, '/build/sapphire/$1$2'); } else if (docsRegex.test(node.url)) { node.url = node.url.replace(docsRegex, '/$1$2'); } else {