Skip to content

Commit

Permalink
fix: docs (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
PatrickAlphaC authored Oct 18, 2024
1 parent 4dcd8ff commit dc44a07
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 9 deletions.
38 changes: 32 additions & 6 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -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
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
```
43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -76,7 +113,7 @@ The documentation roughly attempts to follow [Diátaxis](https://diataxis.fr/).
<p align="center">
<br />
<a href="https://cyfrin.io/">
<img src="./docs/source/_static/speed-comparisons.png" width="1000" alt=""/></a>
<img src="./docs/source/_static/speed-comparisons.png" width="70%" alt=""/></a>
<br />
</p>
Expand Down

0 comments on commit dc44a07

Please sign in to comment.