Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/automata-network/docs

Automata Network Documentation
https://github.com/automata-network/docs

blockchain distributed-systems documentation privacy

Last synced: 8 days ago
JSON representation

Automata Network Documentation

Awesome Lists containing this project

README

        

# Automata Network Documentation

This repository has the documentation for [Automata Network](https://ata.network).

The docs are written in Markdown and you can directly read it [here](./docs).

## Development

```bash
# 1. Clone the repository
git clone https://github.com/automata-network/docs.git

# 2. Install python3 packages
pip3 install -r requirements.txt

# 3. Start the website locally
mkdocs serve
```

## Contributing

You are welcomed to:

* raise an issues regarding the documentation and the hosted website.
* create new documentations under [`docs/`](./docs) directory.
* enrich your documentations with more [mkdocs-material features](https://squidfunk.github.io/mkdocs-material/reference)
* get your hands dirty with [mkdocs][mkdocs] and [mkdocs material][mkdocs-material].

## Acknowledgements

Kudos to the following open-source projects.

* [mkdocs][mkdocs]
* [mkdocs-material][mkdocs-material]

## License

[Apache 2.0](./license)

[mkdocs]: https://www.mkdocs.org/
[mkdocs-material]: https://squidfunk.github.io/mkdocs-material/