This repo contains the restructured text source files for our Sidechain SDK wiki which are hosted via readthedocs.org
-
Raise an issue here. Ensure your issue includes a full, concise description of the changes you feel are needed. Please ensure your issue is specific to the page and section of the documentation you are referring to. If your contribution is complex, please see the next bullet point.
-
Fork our repository and clone it locally. You can then make your proposed changes and push to your remote repository. Once complete, create your pull request against the Horizen official repo. When creating your pull request against our repo, please raise it against our development branch. If you issue a pull request against the master branch, you will be asked to change it.
We review pull requests in the order that they arrive. We may take some time to either comment on, merge, or request changes to your contribution if your contribution content is based on features that are still in development or we have large high priority tasks in progress.
-
We include a local docker build tool to allow you to see your changes as you are making them. This allows you to see what your contribution looks like in your local browser before you submit your pull request. To use this functionality, please ensure you have Docker correctly installed for your platform along with docker-compose. From the terminal, change directory to the root of the project and issue the following command.
docker-compose up --build
After the build finishes, open your browser and head to http://127.0.0.1:8100.
The browser window will automatically refresh on every code edit to the local source files. This allows you to see how the documentation would look if it were live.