From 2a482986942864d29d282a610fa58009ec76f6ec Mon Sep 17 00:00:00 2001 From: Chris Hager Date: Mon, 30 Oct 2023 20:47:38 +0100 Subject: [PATCH] cleanup --- Makefile | 7 +++++++ README.md | 2 +- docs/sidebars.js | 48 ++++++++++++++++++++++++------------------------ docs/technical | 2 +- 4 files changed, 33 insertions(+), 26 deletions(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..bea991de --- /dev/null +++ b/Makefile @@ -0,0 +1,7 @@ +.PHONY: docker docker-start + +docker: + docker run -p 3000:3000 --name suave-docs --rm -it -w /mnt -v $(pwd):/mnt node:20 /bin/bash + +docker-start: + docker run -p 3000:3000 --name suave-docs --rm -it -w /mnt -v $(pwd):/mnt node:20 /usr/local/bin/yarn start diff --git a/README.md b/README.md index 96ab5a6a..dc2ce9b8 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Use Node.js v18+ Note: if you want to install the node packages from within a Docker container (recommended for security), then you can start it like this: ```sh -docker run -p 3000:3000 --rm -it -w /mnt -v $(pwd):/mnt node:18 /bin/bash +docker run -p 3000:3000 --name suave-docs --rm -it -w /mnt -v $(pwd):/mnt node:20 /bin/bash ``` First create a copy of the environment file `.env.template` in the root of the codebase and rename it to `.env` diff --git a/docs/sidebars.js b/docs/sidebars.js index aabb0994..1ac2ca41 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -35,30 +35,30 @@ module.exports = { 'technical/specs/rigil/README', 'technical/specs/rigil/suave-chain', 'technical/specs/rigil/mevm', 'technical/specs/rigil/confidential-data-store', 'technical/specs/rigil/kettle', 'technical/specs/rigil/bridge', ], }, - { - type: 'category', - label: '⚡ Understanding MEV', - collapsed: false, - link: { type: 'doc', id: 'understand/index' }, - items: [ - 'understand/meaning', - 'understand/welfare', - 'understand/power' - ], - }, - { - type: 'category', - label: '🏴‍☠️ Join Us', - link: { type: 'doc', id: 'join/joining-suave' }, - items: [ - 'join/code-of-conduct', - ], - }, - { - "Policies": [ - 'policies/privacy', 'policies/terms-of-service', 'policies/prohibited-use-policy' - ] - }, + // { + // type: 'category', + // label: '⚡ Understanding MEV', + // collapsed: false, + // link: { type: 'doc', id: 'understand/index' }, + // items: [ + // 'understand/meaning', + // 'understand/welfare', + // 'understand/power' + // ], + // }, + // { + // type: 'category', + // label: '🏴‍☠️ Join Us', + // link: { type: 'doc', id: 'join/joining-suave' }, + // items: [ + // 'join/code-of-conduct', + // ], + // }, + // { + // "Policies": [ + // 'policies/privacy', 'policies/terms-of-service', 'policies/prohibited-use-policy' + // ] + // }, { type: 'link', label: 'Forum', diff --git a/docs/technical b/docs/technical index f1b9f8e5..3d402eb8 160000 --- a/docs/technical +++ b/docs/technical @@ -1 +1 @@ -Subproject commit f1b9f8e575365109709565e75c27cd32c7d18877 +Subproject commit 3d402eb835e3ffd8a2a90ffacbc9e900ba40f1f1