Page tree
Skip to end of metadata
Go to start of metadata

The pages in this section contain information about contributing to Besu technical documentation.

If you have any questions about Besu or its documentation, ask on Discord.

Documentation system overview

At the root of the Besu documentation repository (besu-docs), the docs directory contains all the site documentation, which is generated into a static HTML website using MkDocs and the Material for MkDocs theme.

The documentation is automatically updated using webhooks linking GitHub to the ReadTheDocs site when you merge a pull request in the main branch of the Besu documentation repository.


Important note about Github token renewal

The webhook triggers the Read The Docs build.

This build uses a Github PAT for the hyperledger-bot as environment variable (MKDOCS_GITHUB_USER and MKDOCS_GITHUB_TOKEN) to install MKDocs Material insider theme with Python pip.

The PAT for hyperledger-bot has to be renewed every 90 days by asking community-architects@hyperledger.org 

The PAT probably has to be renewed if RTD build fails with the following error in the builds:

fatal: Authentication failed for 'https://github.com/squidfunk/mkdocs-material-insiders.git/'

The system also detects tags in the GitHub repository and makes the latest stable release and previous versions available.

Required accounts

If you want to contribute to the documentation, you need a Linux Foundation account.

If you want to raise a documentation issue, you need an Atlassian account.

Table of contents

  • No labels