aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorbenk10 <ben.kaufman10@gmail.com>2021-01-23 10:01:31 +0200
committerbenk10 <ben.kaufman10@gmail.com>2021-01-23 10:01:31 +0200
commite147af762404b1f9b26c1ef3e709fd101517fa2c (patch)
tree37d3cc802e988289d26e3fda2dee7fbd290c1fb0 /doc
parentb7e12b350d3238fcdfea3bb4c2b064cdd9c43d81 (diff)
downloadbitcoin-e147af762404b1f9b26c1ef3e709fd101517fa2c.tar.xz
doc: add instructions for generating RPC docs
Added instructions on how to generate the up to date RPC docs for the bitcoincore.org website in the relevant release-process subsection.
Diffstat (limited to 'doc')
-rw-r--r--doc/release-process.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/release-process.md b/doc/release-process.md
index 92845bcc82..9fdb19edf1 100644
--- a/doc/release-process.md
+++ b/doc/release-process.md
@@ -326,6 +326,18 @@ bitcoin.org (see below for bitcoin.org update instructions).
- bitcoincore.org RPC documentation update
+ - Install [golang](https://golang.org/doc/install)
+
+ - Install the new Bitcoin Core release
+
+ - Run bitcoind on regtest
+
+ - Clone the [bitcoincore.org repository](https://github.com/bitcoin-core/bitcoincore.org)
+
+ - Run: `go run generate.go` while being in `contrib/doc-gen` folder, and with bitcoin-cli in PATH
+
+ - Add the generated files to git
+
- Update packaging repo
- Push the flatpak to flathub, e.g. https://github.com/flathub/org.bitcoincore.bitcoin-qt/pull/2