Skip to content

Commit 16131ce

Browse files
updating README
1 parent bbd70f8 commit 16131ce

File tree

1 file changed

+48
-9
lines changed

1 file changed

+48
-9
lines changed

README.md

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,61 @@
11
# polygon-docs
22

3-
Polygon Docs website, built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
3+
Welcome to the Polygon Docs website, built with [the Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/).
44

55
## Instructions for use
66

7-
Please open a branch and we will approve each other's work for now.
7+
Work on a local branch and request a review from a teammate.
88

9-
## Running Locally
9+
## How to run the site locally
1010

11-
### Python
11+
### Clone the repo
1212

13-
You must have Python 3.11, `pip3` and the `virtualenv` Python package installed. Then, simply run:
13+
```sh
14+
git clone https://github.com/0xPolygon/polygon-docs.git
15+
cd polygon-docs
16+
```
17+
18+
### Run with Python
19+
20+
1. Download and install Python 3.11: https://www.python.org/downloads/
21+
22+
2. Install the `virtualenv` package:
23+
24+
```sh
25+
pip install virtualenv
26+
```
27+
28+
3. Build and serve the html
1429

15-
```bash
30+
```sh
1631
./run.sh
1732
```
1833

19-
### Docker
34+
The site runs at: http://127.0.0.1:8000/
35+
36+
### Run with Docker
37+
38+
1. Run the following commands from the project root:
39+
40+
```sh
41+
docker build -t polygon-docs .
42+
docker compose up
43+
```
44+
45+
### Run manually
46+
47+
1. Download and install Python, as above, and ensure you have installed all the packages listed in `requirements.txt`, e.g.:
48+
49+
```sh
50+
pip install markdown-include==0.8.1
51+
```
52+
53+
2. Run the following from the project root to bring up the site:
54+
55+
```sh
56+
mkdocs serve --strict
57+
```
58+
59+
## Questions
2060

21-
* `docker build -t polygon-docs .`
22-
* `docker compose up`
61+
Feel free to contact the team any time: `#disc_tkd_techdocs`

0 commit comments

Comments
 (0)