From bbc2f53bae35fbbdbf28919a2e230cbbf3fc3d40 Mon Sep 17 00:00:00 2001 From: tradersnow222 Date: Fri, 11 Oct 2024 15:03:14 -0700 Subject: [PATCH] update README --- docs/README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++ sidebars.js | 18 +++++++------- 2 files changed, 75 insertions(+), 9 deletions(-) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..2398a12 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,66 @@ +--- +sidebar_label: " " +hide_table_of_contents: true +--- + +
+ + +
+ +# Welcome to the 1inch Community & Governance Repository! + +This repository contains all the essential documentation and guidelines related to the 1inch governance processes: + +- **Governance proposals** +- **Voting mechanisms** +- **Role responsibilities** +- **Community participation** +- **And more** + +Our goal is to ensure transparent and effective decision-making within the 1inch community. Contributions and feedback are highly encouraged to help us improve and evolve our governance practices. + +*** + + +# Website + +This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator. +This repo contains submodules that you need to pull `git submodule update --recursive` + +### Installation + +``` +$ pnpm install +``` + +### Local Development + +``` +$ pnpm start +``` + +This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. + +### Build + +``` +$ pnpm build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. + +### Info about development +You can see `warning` in time `pnpm install` - it's okey + +File `docs\limit-order-protocol\smart-contract\_category_.json` changed after `pnpm install`. Discard changes in this file before execute some other commands + +Search doesn't work in `pnpm start`. +For check working of the search you need: +- `pnpm build` +- `pnpm serve` + +If you got some error check that you does all in accordiance with README. +After that remove `pnpm-lock.yaml` (`package-lock.json`), `node_modules` and `build` (if there is one). And try again. +Also check node.js version. All correct worked with node version 18.2.0 + diff --git a/sidebars.js b/sidebars.js index 981a73c..121a6c9 100644 --- a/sidebars.js +++ b/sidebars.js @@ -9,18 +9,18 @@ Create as many sidebars as you want. */ -module.exports = { - // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - - // But you can create a sidebar manually - /* + module.exports = { tutorialSidebar: [ { type: 'category', - label: 'Tutorial', - items: ['hello'], + label: 'Governance', + items: [ + 'governance/overview', // Correct document ID + 'governance/voting-process', // Correct document ID + 'governance/dao-treasury', // Correct document ID (previously misnamed) + // Add more valid document IDs here + ], }, ], - */ }; +