RPC documentation cleanup ideas #22799

1. 
   MarcoFalke commented at 7:21 pm on August 25, 2021: member

   • Auto-formatting and sanity checking the RPCExamples with RPCMan
   • Checking passed-in json in self-check. Removing redundant checks (RPCTypeCheck)
   • De-duplicate default values (Started in #20017)
   • Compile the RPC documentation at compile-time to ensure it doesn’t change at runtime and is completely static
2. MarcoFalke added the label Feature on Aug 25, 2021
3. 
   saranshisatgit commented at 11:24 am on August 30, 2021: none

   I would like to contribute but this is my first time . Would like to give me specifics about where to start ?
4. 
   MarcoFalke commented at 12:09 pm on August 30, 2021: member

   If you want to work on this, I suggest to familiarize yourself with that part of the codebase first. The best way to do that is by reviewing the linked pull requests in the description above.

   Also, see the general recommendations:

   Getting started to contribute to Bitcoin Core

   Setting up your development environment

   New developers are very welcome and needed. There are a lot of open issues of any difficulty waiting to be fixed. However, before you start contributing, familiarize yourself with the Bitcoin Core build system and tests. Refer to the documentation in the repository on how to build Bitcoin Core and how to run the unit and functional tests. Once that is done, you are all set.

   If you need more help getting started, please refer to the following resources:

   • https://medium.com/@amitiu/onboarding-to-bitcoin-core-7c1a83b20365
   • https://jonatack.github.io/articles/how-to-review-pull-requests-in-bitcoin-core

   Pick something to work on

   If you are looking for useful contributions to help out with, you can

   • Search through the good first issues or the ones that are up for grabs. Some of them might no longer be applicable. So if you are interested, but unsure, you might want to leave a comment on the issue first.
   • Write tests to improve the coverage. Any kind of test is welcome and coverage information can be obtained from a relatively recent coverage report. If you are unsure, don’t hesitate to check back first.
   • Help with review and testing. There are easy ones such as the gui and rpc. However, review on any open pull request is welcome. Review will also help you understand the codebase better.
   • Help on meta projects related to Bitcoin Core, such as a high-level performance monitor.
   • Join us on irc and let us know what you are interested in.
5. 
   promag commented at 7:29 pm on September 29, 2021: member

   I’d like to include support for “streaming”: Some RPC methods return big JSON, which is constructed in memory and then serialized as one big string.
6. 
   fanquake commented at 2:09 pm on August 14, 2022: member

   Maybe combine #14894 into this issue, or vice-versa?
7. MarcoFalke added the label Docs on Jun 15, 2023
8. MarcoFalke added the label RPC/REST/ZMQ on Jun 15, 2023

Contributors
MarcoFalke saranshisatgit promag fanquake

Labels
Feature Docs RPC/REST/ZMQ