Every Besu documentation version (including patch) is tagged in the repository, but the published documentation site only contains the three latest minor versions and the in-flight development version are displayed in the published documentation site (for example: development, 23.10.2, 23.7.3, and 23.4.1).latest version – that is, new documentation is published as features are released.
Document version-specific information
We recommend most users upgrade to the latest version of Besu (especially on Mainnet), but for some enterprise use cases, it might be helpful to include version-specific information in the documentation. For example, if a new JSON-RPC method qbft_getPendingVotes
is released with version 24.9.0, add something like the following to the method description. This informs enterprise users whether their version of Besu supports the new method.
View older documentation versions
To build or host a specific version that might not be published on the doc site older version of the documentation (for example, 23.7.1):
- Clone the
besu-docs
repository and checkout the tag for your intended version:git clone git@github.com:hyperledger/besu-docs.git
git cd besu-docs
git checkout 23.7.1
- Build and run locally:
yarn
yarn run start
- Open a browser tab and navigate to
http://localhost:3000/development
- (Optional) Host this version on your own infrastructure (for example, nginx or s3):
yarn
yarn run build
yarn run serve
(optional – this is to check the output locally)
...