diff --git a/documentation/README.md b/documentation/README.md index 6ccca605b4..de968a158c 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -10,12 +10,38 @@ These docs are hosted at [nymtech.net/docs](www.nymtech.net/docs). * `developers` contains key concepts for developers, required architecture, and Rust/Typescript SDK docs. * `operators` contains node setup and maintenance guides. +## Local development +### Dependencies +Our `prebuild` script relies on the following: +- `python` +- `pip` +- [`pandas`](https://pandas.pydata.org/) +- [`tabulate`](https://pypi.org/project/tabulate/) +- `jq` + +Otherwise make sure to have `node` installed. + +### Serve Local (Hot Reload) +```sh +pnpm i +pnpm run dev +``` + +Open `http://localhost:3000`. + +## Build +```sh +pnpm run build +``` + +The static output will be in `./out`; + ## Contribution * If you wish to add to the documentation please create a PR against this repo, with a `patch` against `develop`. ## Scripts * There are several autogenerated command files for clients and binaries. These are generated with `generate:commands`, which runs the `autodoc` rust binary, moves the files to their required places, and then if there is an update, commits them to git. This is for remote deployments. -* TODO +* Python scripts TODO ### Autodoc `autodoc` is a script that generates markdown files containing commands and their output (both command and `--help` output). For the moment the binaries and their commands are manually configured in the script.