Skip to content

nodecross/nodex-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NodeX Official Documentation

The NodeX Official Documentation is designed to organize and disseminate all publicly available information that makes up the NodeX platform. The documentation will be updated as needed, but if you find a bug in the documentation, please follow the contributor guide below to submit a pull request.

Getting started

This document follows the Sphinx documentation framework. This document follows the Sphinx documentation framework, so you can easily build the documentation in your own environment. Note that you need to have Python 3.x version installed to build the documentation.

Clone the repository

git clone https://github.com/getnodex/nodex-docs.git
cd nodex-docs
git switch -c sphinx origin/sphinx

Install dependencies

make install

Build document (auto-reload)

make watch

Contributing

Click here for bug report and feature request regarding the contents of this document. Thanks for your feedback to help us to improve.

License

Apache License 2.0