Comment
Author: Admin | 2025-04-28
Bitcoin Core documentation is spread across three projects: BitcoinCore, the Bitcoin Wiki, and Bitcoin.org—and is further subdivided intodifferent parts. The sections below briefly describe what documentationis available and how you can contribute. Bitcoin Core Docs Directory The developer.bitcoin.org GitHub repositorycontains various files describing aspects of Bitcoin Core. Almost all ofthe files are meant for developers and testers rather than users. The files can be easily edited in GitHub’s web interface: Create a GitHub account, or if you already have one, log in. Find the file you want to edit. Click the Edit icon (a pencil). Make your change and click the Preview button to preview it. Reviseand edit until you’re happy with it. At the bottom of the page, fill out the Propose File Change form andsubmit it. Need help getting started? Stop by the #bitcoin-dev IRC chatroomand tell us what documentation you want to write. Bitcoin.org Bandwidth Sharing Guide The Bitcoin.org bandwidth sharing guidecurrently provides instructions for how to install Bitcoin Core onmultiple operating systems, configure it to automatically start at boot,and manually open port 8333 so it accepts incoming connections. To contribute, you can edit the guide using the same GitHub web interface as described in theprevious section. Need help getting started? You can open an issue or email Bitcoin.orgdocumentation maintainer Will Binns. Bitcoin Wiki The Bitcoin Wiki uses the popular MediaWiki software, so you may alreadyknow how to edit it and create new pages. To reduce spam, you need tocreate an account and then follow theinstructions to enable editing. Current documentation can be found in the Bitcoin Core documentationcategory. If you create a new page,be sure to add it to the Bitcoin Core documentation template and then add the following code tothe very bottom of the page: {{Bitcoin Core documentation}} Adding the line above to a page will also add that page to the BitcoinCore documentation category. Need help getting started? Stop by the #bitcoin-wiki IRC chatroom andtell us what documentation you want to write. Bitcoin.org RPC/REST API Reference The Bitcoin.org developer reference contains over 100 printedpages worth of documentation for the Bitcoin Core RPC and RESTinterfaces, which are mainly used by Bitcoin Core command line users anddevelopers of apps depending on Bitcoin Core. To contribute RPC edits, the easiest way is to: Go to the developer.bitcoin.org GitHub repository. Create a GitHub account, or if you already have one, log in. Find the file you want to
Add Comment