...
We recommended previewing your work locally before pushing your changes within a pull-request. before it's merged. There's two options, building locally using Python virtual environments or previewing using ReadTheDocs PR preview.
As the final documentation is build with MkDocs, you have to build building your docs locally or on ReadTheDocs PR preview with this tool to ensure ensures the Markdown is correctly understood and displayed.
Preview with ReadTheDocs
When creating a PR on the doc repository, checks will trigger to verify links, markdown syntax, writing style and some more. It will also build the doc on ReadTheDocs as a PR preview.
You can find the link to this preview in the check list at the bottom of your PR page as shown on the following screenshot:
Preview Locally
Check locally before pushing your changes within a pull-request.
To preview Hyperledger Besu documentation locally:
...