Skip to content

Latest commit

 

History

410 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Berachain Documentation

License: MIT PRs Welcome Contributors Docs Mintlify

Documentation for Berachain, 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

  • General: Berachain concepts, Proof of Liquidity, tokens, governance, and help
  • BEX: deprecated exchange documentation
  • Bend: lending concepts and guides
  • Build: developer guides, integrations, and contract reference
  • Nodes: node architecture, setup, operations, staking pools, and Beacon Kit reference

Content is in MDX. docs.json defines navigation and branding. STRUCTURE.md defines content placement.


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

Run the full gate before opening a pull request. Start the local server in another terminal because the gate checks redirects:

make dev
make check

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
├── bex/               # Deprecated BEX user docs
├── bend/              # Bend user docs
├── build/             # Developer docs
├── nodes/             # Node and validator docs
├── snippets/          # Shared and generated MDX
├── data/              # Generator inputs
├── scripts/           # Validation and generation
├── 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

Code of conduct

Contributing

Stars

2 stars

Watchers

1 watching

Forks

Used by

Contributors

Languages