commit skeleton docs site

This commit is contained in:
kmurphypolygon
2024-03-06 14:21:33 +01:00
parent 4bc4bea0db
commit d8cf98a0b5
9 changed files with 141 additions and 0 deletions

36
docs/README.md Normal file
View File

@@ -0,0 +1,36 @@
# Miden base documentation
Welcome to the Miden client repo docs.
## Running locally
### Prerequisites
1. [Python 3.12](https://www.python.org/downloads/).
2. [`virtualenv`](https://pypi.org/project/virtualenv/): Install using `pip3 install virtualenv`.
### Setup
1. Clone the repository.
2. `cd` to the root.
3. Run the `run.sh` script. You may need to make the script executable: `chmod +x run.sh`
```sh
./run.sh
```
The site comes up at http://127.0.0.1:8000/
## Style guide
We are using the [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).
## Contributing
1. Fork the `main` branch into your own GitHub account and create a feature branch for your changes.
2. Commit changes and create a PR.
## Contact
- For docs issues (technical or language) open an issue here.
- For anything else, join our [Discord](https://discord.gg/0xpolygondevs).

View File

@@ -0,0 +1 @@
WIP

1
docs/hash-functions.md Normal file
View File

@@ -0,0 +1 @@
WIP

View File

@@ -0,0 +1 @@
WIP

1
docs/welcome.md Normal file
View File

@@ -0,0 +1 @@
WIP