Skip to content

Commit

Permalink
update README pages
Browse files Browse the repository at this point in the history
  • Loading branch information
tradersnow222 committed Oct 11, 2024
1 parent 0dadfd3 commit 572fe08
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 42 deletions.
44 changes: 2 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,57 +6,17 @@

# Welcome to the 1inch Community & Governance Repository!

This repository contains all the essential documentation and guidelines related to the 1inch governance processes:
This repository contains all 1inch Community-owned assets, including essential documentation and guidelines related to 1inch governance processes:

- **Governance proposals**
- **Voting mechanisms**
- **Role responsibilities**
- **Community participation**
- **DAO Improvement Proposal Deliverables**
- **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

66 changes: 66 additions & 0 deletions docs/README.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
sidebar_position: -1
sidebar_label: " "
---

<div align="center">
<img src="https://github.com/1inch/farming/blob/master/.github/1inch_github_w.svg#gh-light-mode-only" />
<img src="https://github.com/1inch/farming/blob/master/.github/1inch_github_b.svg#gh-dark-mode-only" />
</div>

# 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

0 comments on commit 572fe08

Please sign in to comment.