cdesouza-chromium
2ae8b2603b
This PR removes the exclusion of `README.md` from `.prettierignore`. This exclusion was possibly meant to not alter the root `README.md`, but it was also indiscriminately exclusing any `README.md` in subpaths. With this change, we enable the auto format for all `README.md` files, including the one in the root path, as there is no good reason not to. Bug: N/A
2.8 KiB
2.8 KiB
Brave docs
This directory contains documentation for the Brave Browser. For additional resources outside this repository, go to:
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).
Security and Privacy
- Premium Account Privacy - How blind tokens decouple payment identity from service usage.
- Cryptographic Features - Cryptographic features in Brave beyond standard Chromium encryption.
General Development
- 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.
- 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.
Creating Documentation
Important
If you add new documents, please also add a link to them in the Document Index below.
Guidelines
- Markdown documents must follow the Markdown Style Guide.
Use npm run format to auto format documents.
Previewing changes
Locally using md_browser
# in src/brave/
npm run docs
This is only an estimate. The github view may differ.