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) and/or a product team. 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.
This guide assumes familiarity with Git, GitHub, and Markdown.
Most of 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 | Site platform | Hosting platform | Description |
---|---|---|---|---|
Teku | consensys/doc.teku | Docusaurus | Vercel | Maintained by the docs team. |
Hyperledger Besu | hyperledger/besu-docs | Docusaurus | GitHub Pages | Maintained by the docs team. This is a Hyperledger project and has its own Besu docs contribution guidelines. |
Web3Signer | consensys/doc.web3signer | Docusaurus | Vercel | Maintained by the docs team. |
MetaMask | metamask/metamask-docs | Docusaurus | Vercel | Maintained by the docs team. This project has additional MetaMask docs contribution guidelines. |
MetaMask Delegation Toolkit | metamask/gator-docs (private) | Docusaurus | Vercel | Maintained by the docs team. |
Infura | infura/docs (private) | Docusaurus | Vercel | Maintained by the docs team. |
Linea | consensys/doc.linea | Docusaurus | Vercel | Maintained by the docs team. |
MetaFi | consensys-vertical-apps/cx-api-docs (private) | Docusaurus | GitHub Pages | Maintained by the docs team and the MetaFi team. |
Phosphor | consensys/doc.consensys-nft (private) | Docusaurus | Vercel | Maintained by the Phosphor team. |
MetaMask Fiat On-Ramp | consensys/doc.metamask-onramp (private) | Docusaurus | Vercel | Maintained by the MetaMask Fiat On-Ramp team. |
GoQuorum | consensys/doc.goquorum | Docusaurus | Vercel | Maintained by the docs team. |
Tessera | consensys/doc.tessera | Docusaurus | Vercel | Maintained by the docs team. |
EthSigner | consensys/doc.ethsigner | Docusaurus | Vercel | Maintained by the docs team. |
gnark | consensys/doc.gnark | Docusaurus | Vercel | Maintained by the docs team. |
MetaMask Institutional | consensys-vertical-apps/metamask-institutional.docs (private) | Docusaurus | GitHub Pages | Maintained by the MetaMask Institutional team. |
Documentation guide (this site) | consensys/docs-template | Docusaurus | Vercel | Maintained by the docs team. |