Brian R. Bondy
92aae1ccc6
Clarify that network auditor entries are only needed for endpoints that do not require user opt-in. Add new best practice (BS-056) requiring all new Brave endpoints be added to the HSTS pin list.
Brave docs
This directory contains documentation for the Brave Browser. For additional resources outside this repository, go to:
Important
If you add new documents, please also add a link to them in the Document Index below.
Creating Documentation
Guidelines
- Markdown documents must follow the Markdown Style Guide.
Previewing changes
Locally using md_browser
# in src/brave/
npm run docs
This is only an estimate. The github view may differ.
Document Index
Checking Out and Patching
- Upgrading Chromium Upgrading
brave-coreto a newer Chromium version. - Patching with
plasterA patching engine for semantical patching of upstream Chromium. - WebUI Overriding
- DevTools Frontend Patching Managing changes to the upstream project.
Tools
- Claude Code Skills - Slash commands for automating common development tasks (commit, review, preflight, CI, and more).
General Development
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.
- 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.