brave-core/docs

Brave docs

This directory contains documentation for the Brave Browser. For additional resources outside this repository, go to:

• brave-browser/wiki

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-core to a newer Chromium version.
• Patching with plaster A patching engine for semantical patching of upstream Chromium.
• WebUI Overriding
• DevTools Frontend Patching Managing changes to the upstream project.

General Development

• gni notes - Brief notes on the use of source.gni files 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.