File tree Expand file tree Collapse file tree 2 files changed +13
-5
lines changed Expand file tree Collapse file tree 2 files changed +13
-5
lines changed Original file line number Diff line number Diff line change @@ -8,11 +8,16 @@ request](https://github.com/bitcoin-dot-org/developer.bitcoin.org/compare).
88
99## How to contribute
1010
11- This repo hosts the sources for the Bitcoin developer documentation.
11+ This repo hosts the sources for the Bitcoin developer documentation. One of the
12+ easiest ways to get started contributing is by rereading the site and looking for
13+ inconsistencies in terminology, style, etc., and also in any illustrations.
1214
13- It is converted from Markdown to [ reStructuredText
14- (RST)] ( http://docutils.sourceforge.net/rst.html ) and rendered with
15- [ Sphinx] ( http://www.sphinx-doc.org ) .
15+ Prior to contributing, please review the [ style
16+ guide] ( https://github.com/bitcoin-dot-org/developer.bitcoin.org/tree/master/docs/style-guide.md ) .
17+
18+ Much of the content displayed on the is converted from Markdown to
19+ [ reStructuredText (RST)] ( http://docutils.sourceforge.net/rst.html ) and rendered
20+ with [ Sphinx] ( http://www.sphinx-doc.org ) .
1621
1722### Render the documentation locally
1823
@@ -21,7 +26,7 @@ required theme modules, e.g. by running
2126
2227 pip install -r requirements.txt
2328
24- from the root of this repo. Then you can execute Sphinx by calling
29+ This should be done from the root of this repo. Then you can execute Sphinx by calling
2530
2631 make html
2732
Original file line number Diff line number Diff line change @@ -12,6 +12,9 @@ This repo hosts the sources for the Bitcoin developer documentation. One of the
1212easiest ways to get started contributing is by rereading the site and looking for
1313inconsistencies in terminology, style, etc., and also in any illustrations.
1414
15+ Prior to contributing, please review the [ style
16+ guide] ( https://github.com/bitcoin-dot-org/developer.bitcoin.org/tree/master/docs/style-guide.md ) .
17+
1518Much of the content displayed on the is converted from Markdown to
1619[ reStructuredText (RST)] ( http://docutils.sourceforge.net/rst.html ) and rendered
1720with [ Sphinx] ( http://www.sphinx-doc.org ) .
You can’t perform that action at this time.
0 commit comments