Bitcoin Core documentation is collaboratively maintained across three primary projects: Bitcoin Core, the Bitcoin Wiki, and Bitcoin.org—each serving distinct audiences and purposes. Below is a structured guide to available resources and how you can contribute effectively.
Bitcoin Core Developer Documentation
The Bitcoin Core Developer Repository hosts technical files tailored for developers and testers. Follow these steps to contribute:
- Create/Log In to GitHub: Ensure you have a GitHub account.
- Locate the File: Navigate to the file needing edits.
- Edit & Preview: Use GitHub’s pencil icon to modify, preview changes, and refine.
- Submit Proposal: Fill out the "Propose File Change" form to submit edits.
👉 Need real-time guidance? Join #bitcoin-dev IRC for direct support.
Bitcoin.org Bandwidth Sharing Guide
This guide provides step-by-step instructions for setting up Bitcoin Core as a full node, including OS-specific configurations and port settings. To contribute:
- Access the Guide: Visit the Full Node Documentation.
- Edit via GitHub: Use the same workflow as above via the Bitcoin.org repository.
For assistance, open an issue or contact Will Binns.
Bitcoin Wiki Contributions
The Bitcoin Wiki operates on MediaWiki. To edit:
- Create an Account: Required to enable editing privileges.
Categorize Pages: Add new pages to the Bitcoin Core Documentation category by including:
{{Bitcoin Core documentation}}- Use Templates: Ensure consistency with the Bitcoin Core template.
👉 Collaborate in #bitcoin-wiki IRC for community feedback.
Bitcoin.org API Reference
The RPC/REST API Developer Reference details over 100 pages of Bitcoin Core’s interfaces. Contribute via GitHub as outlined earlier.
FAQ Section
Q: How do I start contributing to Bitcoin Core docs?
A: Begin by reviewing existing docs on GitHub or the Wiki, then propose edits via pull requests or direct edits (Wiki).
Q: What technical skills are needed?
A: Basic Markdown/GitHub fluency for most contributions; advanced topics may require C++ or Bitcoin protocol knowledge.
Q: Where can I get peer review?
A: Engage in #bitcoin-dev (IRC) or open GitHub issues for feedback.