This directory contains documentation for the Brave Browser. For additional resources outside this repository, go to:
- Upgrading Chromium Upgrading
brave-coreto a newer Chromium version. - Patching with
plasterA patching engine for semantical patching of upstream Chromium. - Plaster Dos and Don'ts Guidance for authoring robust plasters, and for choosing the right rewriter.
- WebUI Overriding
- DevTools Frontend Patching Managing changes to the upstream project.
- Claude Code Skills - Slash commands for automating common development tasks (commit, review, preflight, CI, and more).
- Premium Account Privacy - How blind tokens decouple payment identity from service usage.
- Cryptographic Features - Cryptographic features in Brave beyond standard Chromium encryption.
- Running test suites - Selectively execute unit, browser and typescript tests.
gninotes - Brief notes on the use ofsource.gnifiles in our code base.- Rust notes - General recommendations on integrating rust code into
brave-core - Adapting Chromium tests to the Brave Codebase - Suggestions on how to make chromium test work on our test targets.
- Ship a File to All Clients - How to ship a file to all clients via component updater.
- Brave Variations (Griffin) - Brave's feature rollout and experimentation service, including best practices for staged rollouts.
- Git Configuration - General recommendations for setting up and optimizing your Git environment.
- Ignoring Files from Format and Presubmit Checks - How to exclude files from format and presubmit checks.
- Siso Customization - How we customize Siso to work for us.
- WebUI Frontend - General Web UI, React, webpack overview.
- WebUI Testing - Guide to creating and running *.test.ts(x) suites.
- WebUI Strings Overview - Including strings in a Web UI frontend.
- WebUI Service Workers - Serving a
chrome-untrusted://WebUI from a service worker, and the restrictions that come with it.
Important
If you add new documents, please also add a link to them in the Document Index below.
- Markdown documents must follow the Markdown Style Guide.
Use pnpm run format to auto format documents.
Locally using md_browser
# in src/brave/
pnpm run docsThis is only an estimate. The github view may differ.