From e8ccb870e91150f1f2603670377a323d16ef1ced Mon Sep 17 00:00:00 2001 From: beruf Date: Thu, 2 Jan 2025 08:53:59 +0100 Subject: [PATCH] docs: move build paratime to build/tools/ --- docs/README.mdx | 2 +- .../tools/build-paratime}/README.mdx | 8 ++--- .../tools/build-paratime/minimal-runtime.md | 1 + docs/build/tools/build-paratime/modules.md | 1 + .../tools/build-paratime/prerequisites.md | 1 + .../tools/build-paratime/reproducibility.md | 1 + .../run-your-node/paratime-client-node.mdx | 2 +- docs/node/run-your-node/paratime-node.mdx | 2 +- docs/paratime/minimal-runtime.md | 1 - docs/paratime/modules.md | 1 - docs/paratime/prerequisites.md | 1 - docs/paratime/reproducibility.md | 1 - docusaurus.config.ts | 6 ---- redirects.ts | 2 +- sidebarBuild.ts | 29 ++++++++++++++++++ sidebarParatime.ts | 30 ------------------- sidebars.ts | 1 - src/remark/cross-repo-links.ts | 2 +- 18 files changed, 42 insertions(+), 50 deletions(-) rename docs/{paratime => build/tools/build-paratime}/README.mdx (64%) create mode 120000 docs/build/tools/build-paratime/minimal-runtime.md create mode 120000 docs/build/tools/build-paratime/modules.md create mode 120000 docs/build/tools/build-paratime/prerequisites.md create mode 120000 docs/build/tools/build-paratime/reproducibility.md delete mode 120000 docs/paratime/minimal-runtime.md delete mode 120000 docs/paratime/modules.md delete mode 120000 docs/paratime/prerequisites.md delete mode 120000 docs/paratime/reproducibility.md delete mode 100644 sidebarParatime.ts diff --git a/docs/README.mdx b/docs/README.mdx index db58e55fca..3de730fb2b 100644 --- a/docs/README.mdx +++ b/docs/README.mdx @@ -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/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/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 3b9f34792f..1bbb1e6376 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/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/docusaurus.config.ts b/docusaurus.config.ts index 18b6c52d46..b6f01c18f4 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -122,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/redirects.ts b/redirects.ts index 9afdc7dcee..d1654833f3 100644 --- a/redirects.ts +++ b/redirects.ts @@ -269,7 +269,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 }, { diff --git a/sidebarBuild.ts b/sidebarBuild.ts index 62d266a155..e84dd14a28 100644 --- a/sidebarBuild.ts +++ b/sidebarBuild.ts @@ -130,6 +130,35 @@ export const sidebarBuild: SidebarsConfig = { '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', 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/sidebars.ts b/sidebars.ts index 4e2c7b9c4d..4d753f2916 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -15,7 +15,6 @@ const sidebars: SidebarsConfig = { ...sidebarGeneral, ...sidebarGetInvolved, ...sidebarNode, - ...sidebarParaTime, }; export default sidebars; diff --git a/src/remark/cross-repo-links.ts b/src/remark/cross-repo-links.ts index 5193a5334d..01e87612bf 100644 --- a/src/remark/cross-repo-links.ts +++ b/src/remark/cross-repo-links.ts @@ -31,7 +31,7 @@ export default function plugin(): Transformer { if (oasisSdkContractRegex.test(node.url)) { 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, '/build/rofl/$1$2'); } else if (cliRegex.test(node.url)) {