Skip to content

Commit

Permalink
docs: move build paratime to build/tools/
Browse files Browse the repository at this point in the history
  • Loading branch information
rube-de committed Jan 2, 2025
1 parent 84a662a commit e8ccb87
Show file tree
Hide file tree
Showing 18 changed files with 42 additions and 50 deletions.
2 changes: 1 addition & 1 deletion docs/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<DocCard item={findSidebarItem('/paratime/')} />
<DocCard item={findSidebarItem('/build/tools/build-paratime/')} />

## Develop Core

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ This chapter will teach you how to build your own ParaTime with [Oasis Runtime
SDK].

<DocCardList items={[
findSidebarItem('/paratime/prerequisites'),
findSidebarItem('/paratime/minimal-runtime'),
findSidebarItem('/paratime/modules'),
findSidebarItem('/paratime/reproducibility'),
findSidebarItem('/build/tools/build-paratime/prerequisites'),
findSidebarItem('/build/tools/build-paratime/minimal-runtime'),
findSidebarItem('/build/tools/build-paratime/modules'),
findSidebarItem('/build/tools/build-paratime/reproducibility'),
findSidebarItem('https://api.docs.oasis.io/rust/oasis_runtime_sdk'),
]} />

Expand Down
1 change: 1 addition & 0 deletions docs/build/tools/build-paratime/minimal-runtime.md
1 change: 1 addition & 0 deletions docs/build/tools/build-paratime/modules.md
1 change: 1 addition & 0 deletions docs/build/tools/build-paratime/prerequisites.md
1 change: 1 addition & 0 deletions docs/build/tools/build-paratime/reproducibility.md
2 changes: 1 addition & 1 deletion docs/node/run-your-node/paratime-client-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::
Expand Down
2 changes: 1 addition & 1 deletion docs/node/run-your-node/paratime-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/paratime/minimal-runtime.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/paratime/modules.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/paratime/prerequisites.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/paratime/reproducibility.md

This file was deleted.

6 changes: 0 additions & 6 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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/',
Expand Down
2 changes: 1 addition & 1 deletion redirects.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
{
Expand Down
29 changes: 29 additions & 0 deletions sidebarBuild.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
30 changes: 0 additions & 30 deletions sidebarParatime.ts

This file was deleted.

1 change: 0 additions & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ const sidebars: SidebarsConfig = {
...sidebarGeneral,
...sidebarGetInvolved,
...sidebarNode,
...sidebarParaTime,
};

export default sidebars;
2 changes: 1 addition & 1 deletion src/remark/cross-repo-links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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)) {
Expand Down

0 comments on commit e8ccb87

Please sign in to comment.