Skip to content
/ docs Public

Berachain's Documentation Repository For Core, BEX, Berps, & Bend

License

Notifications You must be signed in to change notification settings

berachain/docs

Berachain Documentation

License: MIT PRs Welcome Contributors Docs Mintlify

Unified documentation for Berachain and its native protocols: BEX (DEX) and Bend (lending). Built with Mintlify.

We welcome contributions from the community. Whether you're fixing a typo, clarifying a section, or adding a new guide, your help makes our docs better for everyone.


What’s in this repo

  • Berachain (General) — L1 overview, Proof-of-Liquidity, tokens, governance
  • Build — Getting started, BEX, Bend, nodes, validators
  • Reference — APIs, contracts, and technical reference

Content is in MDX. Navigation and branding are configured in docs.json.


Quick start

Prerequisites

  • Node.js v20.17.0+ (LTS recommended)
  • Git
  • npm or pnpm

Install Mintlify CLI

npm i -g mint

Run locally

mint dev

Open http://localhost:3000.

Validate before pushing

Check that the docs build with no warnings or errors (recommended for CI and before opening a PR):

mint validate

Contributing

We use a single main branch. All changes come in via pull requests and go through the same review process, whether from the core team or the community.

  • CONTRIBUTING.md — How to set up your environment, add or edit content, and open a PR
  • CODE_OF_CONDUCT.md — How we work together and what we expect from everyone

Ways to contribute

  • Fix typos or unclear wording
  • Add or improve guides and examples
  • Report missing or incorrect docs via GitHub Issues
  • Suggest improvements in issues before larger changes

If you’re new to open source, see Your first pull request in CONTRIBUTING.


Project layout

docs/
├── docs.json          # Site config, navigation, theme
├── general/           # Berachain core docs
├── build/             # BEX, Bend, nodes, validators
├── reference/         # APIs, contracts
├── logo/
└── images/

New pages are added under the right folder and registered in docs.json under the right tab/group. See CONTRIBUTING.md for the exact steps.


Links

Resource Link
Website berachain.com
Docs (live) docs.berachain.com
GitHub github.com/berachain
Discord discord.gg/berachain
BEX bex.berachain.com
Bend bend.berachain.com

Support

  • Docs bugs or suggestionsOpen an issue
  • Technical or protocol questionsDiscord
  • Security — Do not report security issues in public; see CONTRIBUTING.md for how to report them safely

License

This documentation is licensed under the MIT License.

About

Berachain's Documentation Repository For Core, BEX, Berps, & Bend

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors

Languages