-
Notifications
You must be signed in to change notification settings - Fork 2k
Improving Developer Documentation
Live site: developer.bitcoin.org
Report problems or help improve the site by opening a new issue or pull request.
The developer.bitcoin.org repo hosts the sources for the developer documentation. One of the easiest ways to get started contributing is by rereading the site and looking for inconsistencies in terminology, style, etc., and also in any illustrations.
Prior to contributing, please review the style guide.
Much of the content displayed on the is converted from Markdown to reStructuredText (RST) and rendered with Sphinx.
To render the documentation locally you first need to install Sphinx and the required theme modules, e.g. by running
pip install -r requirements.txt
This should be done from the root of this repo. Then you can execute Sphinx by calling
make html
This will generate HTML from the RST sources in the directory _build/html.
It's all static HTML so you can just open the index.html file in your browser
locally to view the rendered documentation.
The documentation of the RPC commands is automatically generated from the help of a bitcoin client with a helper tool. This is the content in the reference/rpc directory. Changes in these files need to be done through the helper tool or at least backported to the helper tool after doing them in this repo.
Participation in this project is subject to a Code of Conduct.
This project, developer.bitcoin.org, is community supported: 3FkenCiXpSLqD8L79intRNXUgjRoH9sjXa
Please contact Will Binns ([email protected]) if you need help.