Skip to content

Commit e147af7

Browse files
committed
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.
1 parent b7e12b3 commit e147af7

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/release-process.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,18 @@ bitcoin.org (see below for bitcoin.org update instructions).
326326

327327
- bitcoincore.org RPC documentation update
328328

329+
- Install [golang](https://golang.org/doc/install)
330+
331+
- Install the new Bitcoin Core release
332+
333+
- Run bitcoind on regtest
334+
335+
- Clone the [bitcoincore.org repository](https://github.com/bitcoin-core/bitcoincore.org)
336+
337+
- Run: `go run generate.go` while being in `contrib/doc-gen` folder, and with bitcoin-cli in PATH
338+
339+
- Add the generated files to git
340+
329341
- Update packaging repo
330342

331343
- Push the flatpak to flathub, e.g. https://github.com/flathub/org.bitcoincore.bitcoin-qt/pull/2

0 commit comments

Comments
 (0)