Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A new stable version of the Besu documentation is released when a new version of the Besu software is released.

NOTE: If it's the first time (or if any dependencies have changed), you will need to run yarn install to install Docusaurus

You will need node.js version v18.x (use NVM to easily manage node versions).

To release the documentation, first run the following command to create a new doc version:

NOTE if it's the first time, you will need to run yarn  to install docusaurus

Code Block
languagebash
npm run docusaurus docs:version <VERSION-NUMBER>

(This automatically updates versions.json  file to include the new version number.)

Then, in docusaurus.config.js , under presets > classic > docs:

...

  • Under versions :
    • Add the new version and set its label to stable (<VERSION-NUMBER>) and its path to stable .
    • Update the previous version to remove the stable  label and path, and add an unmaintained  banner.

For example, when updating from version 23.4.1  to 23.4.2 , update the following section in docusaurus.config.js  from the following:

...