Audit and fix best practices docs for stale references, duplicates, obsolete content, and formatting issues. Triggers on: fix bp docs, fix best practice docs, audit bp docs.
Audit all best practices documentation files for issues and fix them. This skill
must be run from the brave-core directory.
This skill runs from the brave-core (src/brave) directory. Best practices docs
are at ./docs/best-practices/ and the index is at ./docs/best_practices.md.
Set DOCS_DIR="./docs/best-practices".
Read docs/best_practices.md and every file in $DOCS_DIR/*.md to understand
the full set of docs.
Scan across all docs for rules that cover the same topic. Look for:
When a duplicate is found, keep the version in the more appropriate category file and remove the other. Preserve all anchor IDs on the kept version so existing links don't break.
Do NOT create reference-only stubs that just point to another rule. Either keep the full rule or remove it entirely.
Extract all brave/... file paths from code examples and verify they exist in
src/brave/. For each missing file:
find or GlobSkip paths that are obviously placeholder/illustrative (e.g.,
brave/components/my_feature/my_header.h,
brave/chromium_src/path/to/override.h).
Extract Chromium file paths (e.g., components/omnibox/browser/...,
chrome/browser/ui/...) from code examples and verify they exist in src/. For
each missing file:
Skip paths that are obviously placeholder/illustrative.
Look for references to specific Chromium class names, method names, and other
symbols in code examples. Verify they still exist in the Chromium source
(src/). Update any that were renamed.
Look for references to specific Brave class names, method names, and other
symbols in code examples. Verify they still exist in src/brave/. Update any
that were renamed or removed.
Look for:
../testing-requirements.md)Look for:
--- separators between rules<a id="...">)--- separatorsVerify docs/best_practices.md:
$DOCS_DIR/ are represented in the indexFor each issue found:
After all fixes, run ID validation:
python3 ./script/manage-bp-ids.py --validate
path/to/foo.h), leave it
alone