Consensys documentation guide

Welcome to the Consensys documentation guide. This guide contains information about contributing to Consensys developer documentation sites and creating new documentation sites.

Overview

Each Consensys developer product has a documentation site, maintained by the Consensys developer documentation team (internal page). The docs use a docs-as-code approach and are mostly open source, empowering developers and community members to contribute to the docs alongside the docs team.

This guide aims to help writers, developers, product managers, and community members contribute to the existing doc sites and create new doc sites.

note

This guide assumes familiarity with Git, GitHub, and Markdown.

The doc sites are built using the Docusaurus static site generator and hosted on Vercel.

List of documentation sites

The following table shows the full list of developer documentation sites supported by Consensys.

Doc site	GitHub repository	Description
Teku	Consensys-Incorporated/doc.teku	Maintained by the docs team.
Besu	besu-eth/besu-docs	Maintained by the docs team. Besu is a Linux Foundation Decentralized Trust (LFDT) project and has its own Besu docs contribution guidelines.
Web3Signer	Consensys-Incorporated/doc.web3signer	Maintained by the docs team.
Linea	Consensys-Incorporated/doc.linea	Maintained by the docs team.
gnark	Consensys-Incorporated/doc.gnark	Maintained by the docs team.
Zesu	Consensys-Incorporated/doc.zesu	Maintained by the docs team.
Documentation guide (this site)	Consensys-Incorporated/docs-template	Maintained by the docs team.