Skip to content

Commit 321e8f0

Browse files
author
Will Binns
authored
Merge pull request #75 from bitcoin-dot-org/wbnns-misc-updates
Update repository documentation
2 parents 957ecc0 + 50f0a09 commit 321e8f0

File tree

8 files changed

+534
-22
lines changed

8 files changed

+534
-22
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of
9+
experience, nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers and contributors are responsible for clarifying the
37+
standards of acceptable behavior and are expected to take appropriate and fair
38+
corrective action in response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43+
contributor for other behaviors that they deem inappropriate, threatening,
44+
offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting Will Binns at <will@bitcoin.org>. All complaints will be
59+
reviewed and investigated and will result in a response that is deemed necessary
60+
and appropriate to the circumstances. The project team is obligated to maintain
61+
confidentiality with regard to the reporter of an incident.
62+
63+
Further details of specific enforcement policies may be posted separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72+
version 1.4, available at [http://contributor-covenant.org/version/1/4][version].
73+
74+
[homepage]: http://contributor-covenant.org
75+
[version]: http://contributor-covenant.org/version/1/4/
76+

‎CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Welcome to developer.bitcoin.org's codebase
2+
3+
Live site: [developer.bitcoin.org](https://developer.bitcoin.org)
4+
5+
Report problems or help improve the site by opening a [new
6+
issue](https://github.com/bitcoin-dot-org/developer.bitcoin.org/issues) or [pull
7+
request](https://github.com/bitcoin-dot-org/developer.bitcoin.org/compare).
8+
9+
## How to contribute
10+
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.
14+
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).
21+
22+
### Render the documentation locally
23+
24+
To render the documentation locally you first need to install Sphinx and the
25+
required theme modules, e.g. by running
26+
27+
pip install -r requirements.txt
28+
29+
This should be done from the root of this repo. Then you can execute Sphinx by calling
30+
31+
make html
32+
33+
This will generate HTML from the RST sources in the directory `_build/html`.
34+
It's all static HTML so you can just open the index.html file in your browser
35+
locally to view the rendered documentation.
36+
37+
### Generation of RPC docs
38+
39+
The documentation of the RPC commands is automatically generated from the help
40+
of a bitcoin client with a [helper
41+
tool](https://github.com/bitcoin-dot-org/developer.bitcoin.org/tree/master/helpers/rpc).
42+
This is the content in the [reference/rpc](reference/rpc) directory. Changes in
43+
these files need to be done through the helper tool or at least backported to
44+
the helper tool after doing them in this repo.
45+
46+
## Code of Conduct
47+
48+
Participation in this project is subject to a [Code of
49+
Conduct](https://github.com/bitcoin-dot-org/developer.bitcoin.org/blob/master/CODE_OF_CONDUCT.md).
50+
51+
## Donations
52+
53+
This project, developer.bitcoin.org, is community supported:
54+
[3FkenCiXpSLqD8L79intRNXUgjRoH9sjXa](bitcoin:3FkenCiXpSLqD8L79intRNXUgjRoH9sjXa)
55+
56+
## Questions?
57+
58+
Please contact Will Binns ([will@bitcoin.org](mailto:will@bitcoin.org)) if you
59+
need help.

‎COPYING

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
The intellectual property rights in the files are owned by the respective
2+
authors. Some of the files can be licensed under MIT License (MIT) available on
3+
http://opensource.org/licenses/MIT or other licenses. Appropriate licensing
4+
information can be found in the header of the file or in the folder containing
5+
the file.

‎LICENSE

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Copyright (c) 2009-2019 Bitcoin.org
2-
Copyright (c) 2019 Bitcoin Developer Documentation
1+
Copyright (c) 2019-2020 developer.bitcoin.org
32

43
Permission is hereby granted, free of charge, to any person obtaining a copy
54
of this software and associated documentation files (the "Software"), to deal

‎README.md

Lines changed: 41 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,59 @@
1-
# Bitcoin Developer Documentation
1+
# Welcome to developer.bitcoin.org's codebase
22

3-
This repo hosts the sources for the Bitcoin developer documentation.
3+
Live site: [developer.bitcoin.org](https://developer.bitcoin.org)
44

5-
It is an experimental port of the documentation hosted at [bitcoin.org](https://bitcoin.org/en/developer-documentation) ([sources](https://github.com/bitcoin-dot-org/bitcoin.org)), converted from Markdown to [reStructuredText (RST)](http://docutils.sourceforge.net/rst.html) and rendered with [Sphinx](http://www.sphinx-doc.org).
5+
Report problems or help improve the site by opening a [new
6+
issue](https://github.com/bitcoin-dot-org/developer.bitcoin.org/issues) or [pull
7+
request](https://github.com/bitcoin-dot-org/developer.bitcoin.org/compare).
68

7-
## Render the documentation locally
9+
## How to contribute
810

9-
To render the documentation locally you first need to install Sphinx and the required theme modules, e.g. by running
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.
14+
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).
21+
22+
### Render the documentation locally
23+
24+
To render the documentation locally you first need to install Sphinx and the
25+
required theme modules, e.g. by running
1026

1127
pip install -r requirements.txt
1228

13-
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
1430

1531
make html
1632

17-
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.
18-
19-
## Import from bitcoin.org
33+
This will generate HTML from the RST sources in the directory `_build/html`.
34+
It's all static HTML so you can just open the index.html file in your browser
35+
locally to view the rendered documentation.
2036

21-
The RST is generated from the original Markdown sources from bitcoin.org using a helper script, which resides in the [helpers](helpers) directory. Run the script by calling
37+
### Generation of RPC docs
2238

23-
helpers/import-docs <bitcoin-dot-org/bitcoin.org checkout>
39+
The documentation of the RPC commands is automatically generated from the help
40+
of a bitcoin client with a [helper
41+
tool](https://github.com/bitcoin-dot-org/developer.bitcoin.org/tree/master/helpers/rpc).
42+
This is the content in the [reference/rpc](reference/rpc) directory. Changes in
43+
these files need to be done through the helper tool or at least backported to
44+
the helper tool after doing them in this repo.
2445

25-
with the path to a local checkout of [bitcoin-dot-org/bitcoin.org](https://github.com/bitcoin-dot-org/bitcoin.org) as argument. This will regenerate the RST files based on the content from the bitcoin.org repository.
46+
## Code of Conduct
2647

27-
This is a temporary mechanism to port the documentation to RST. Once the import is in a good shape and the original information is captured correctly in the converted files, the RST files will become the original source, and the import is not needed anymore. There is a [milestone](https://github.com/bitcoin-documentation/website/milestone/1) to track the necessary work to be done before detaching from the Markdown sources.
48+
Participation in this project is subject to a [Code of
49+
Conduct](https://github.com/bitcoin-dot-org/developer.bitcoin.org/blob/master/CODE_OF_CONDUCT.md).
2850

29-
## Generation of RPC docs
51+
## Donations
3052

31-
The documentation of the RPC commands is automatically generated from the help of a bitcoin client with another [helper tool](https://github.com/cornelius/rpc-docs-helper). This is the content in the [reference/rpc](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.
53+
This project, developer.bitcoin.org, is community supported:
54+
[3FkenCiXpSLqD8L79intRNXUgjRoH9sjXa](bitcoin:3FkenCiXpSLqD8L79intRNXUgjRoH9sjXa)
3255

33-
## License
56+
## Questions?
3457

35-
The content of this repo is licensed under the [MIT license](LICENSE).
58+
Please contact Will Binns ([will@bitcoin.org](mailto:will@bitcoin.org)) if you
59+
need help.

‎_theme/footer.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,8 @@
114114
<div>{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} Released under the MIT License.</div>
115115
{%- endif %}
116116
<div>
117-
<a class="footer-bottom-link" href="mailto:contact@bitcoindocumentation.org">Feedback</a>
118-
<a class="footer-bottom-link" href="mailto:contact@bitcoindocumentation.org">Questions</a></div>
117+
<a class="footer-bottom-link" href="mailto:will@bitcoin.org">Feedback</a>
118+
<a class="footer-bottom-link" href="mailto:will@bitcoin.org">Questions</a></div>
119119
</div>
120120
</footer>
121121

‎conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
# -- Project information -----------------------------------------------------
2020

2121
project = u'Bitcoin'
22-
copyright = u'Bitcoin Project 2009-2019'
22+
copyright = u'Bitcoin Project 2009-2020'
2323
author = u'Bitcoin Developer Documentation'
2424

2525
# The short X.Y version

0 commit comments

Comments
 (0)