diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 16d4189..5130fc9 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,15 +1,41 @@ -> Docs are a work in process. +# Documentation -1. Install the docs dependencies +## About + +The documentation roughly attempts to follow [Diátaxis](https://diataxis.fr/). + +## View + +As of today, you can [view the moccasin documentation here.](https://cyfrin.github.io/moccasin/) + +## Build + +To build the documentation, you can do the following. + +1. Follow the `Installing for local development` instructions in the [CONTRIBUTING.md](./CONTRIBUTING.md) file. + +2. Add dependencies ```bash -uv sync --extra docs +uv sync --all-extras ``` -2. Run the build - +3. Build the documentation + ```bash just docs ``` -3. Open `built_docs/html/index.html` in your browser, however you please \ No newline at end of file +4. Open the documentation in your browser of choice. + +If using something like VSCode's live server, open: + +```bash +http://127.0.0.1:5500/built_docs/html/index.html +``` + +Or: + +```bash +/path/to/your/file/built_docs/html/index.html +``` \ No newline at end of file diff --git a/README.md b/README.md index 298d01a..349098b 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ Fast to install, test, and run python commands on your smart contracts. # Quickstart -Head over to [the moccasin installation documentation](https://cyfrin.github.io/moccasin/installing-moccasin.html) to for other install methodologies and getting stated. +Head over to [the moccasin installation documentation](https://cyfrin.github.io/moccasin/installing_moccasin.html) to for other install methodologies and getting stated. ## This README Quickstart @@ -59,7 +59,44 @@ mox --help # Documentation -The documentation roughly attempts to follow [Diátaxis](https://diataxis.fr/). +You can view the documentation [here](https://cyfrin.github.io/moccasin/). + +# Contributing + +If you're interested in helping build moccasin, please see the [contributing guide](./CONTRIBUTING.md). + +# Help output + +```bash +mox --help +usage: Moccasin CLI [-h] [-d] [-q] + {init,compile,build,test,run,script,deploy,wallet,console,install,purge,config,explorer,inspect,deployments,utils,u,util} + ... + +🐍 Pythonic Smart Contract Development Framework + +positional arguments: + {init,compile,build,test,run,script,deploy,wallet,console,install,purge,config,explorer,inspect,deployments,utils,u,util} + init Initialize a new project. + compile (build) Compiles the project. + test Runs all tests in the project. + run (script) Runs a script with the project's context. + deploy Deploys a contract named in the config with a deploy script. + wallet Wallet management utilities. + console BETA, USE AT YOUR OWN RISK: Interact with the network in a python shell. + install Installs the project's dependencies. + purge Purge a given dependency + config View the Moccasin configuration. + explorer Work with block explorers to get data. + inspect Inspect compiler data of a contract. + deployments View deployments of the project from your DB. + utils (u, util) Helpful utilities - right now it's just the one. + +options: + -h, --help show this help message and exit + -d, --debug Run in debug mode + -q, --quiet Suppress all output except errors +``` # Acknowledgements @@ -76,7 +113,7 @@ The documentation roughly attempts to follow [Diátaxis](https://diataxis.fr/).


- +