Skip to content

Commit 7c77916

Browse files
author
Will Binns
committed
README: Additional text tweaks to contributing section
1 parent 89d538a commit 7c77916

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ 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+
Much of the content displayed on the is converted from Markdown to
16+
[reStructuredText (RST)](http://docutils.sourceforge.net/rst.html) and rendered
17+
with [Sphinx](http://www.sphinx-doc.org).
1618

1719
### Render the documentation locally
1820

@@ -21,7 +23,7 @@ required theme modules, e.g. by running
2123

2224
pip install -r requirements.txt
2325

24-
from the root of this repo. Then you can execute Sphinx by calling
26+
This should be done from the root of this repo. Then you can execute Sphinx by calling
2527

2628
make html
2729

0 commit comments

Comments
 (0)