fix-bp-docs

Audit and correct best practices documentation for stale references and formatting issues.

3.5k|1.4k|Updated Nov 10, 2017
One-click install
npx skills add https://github.com/brave/brave-core --skill fix-bp-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fix-bp-docs
Source: https://github.com/brave/brave-core/tree/main/.claude/skills/fix-bp-docs
Command: npx skills add https://github.com/brave/brave-core --skill fix-bp-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill addresses the issue of outdated, duplicated, or incorrectly formatted documentation within the 'best practices' section of the Brave Core repository, ensuring accuracy and maintainability.

Core Features & Use Cases

  • Content Auditing: Scans documentation for stale references, duplicate rules, and formatting inconsistencies.
  • Reference Correction: Updates broken internal and external links, as well as stale file and symbol references within code examples.
  • Use Case: A developer needs to ensure that all best practice guidelines are up-to-date and accurate before a new release, using this skill to automatically identify and fix any issues in the documentation.

Quick Start

Run the fix-bp-docs skill to audit and correct issues in the best practices documentation.

Frequently Asked Questions about fix-bp-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit best practices documentation for stale references and broken links?

You can audit best practices documentation by scanning Markdown files to verify file paths, symbols, and links against source code directories, identifying stale references, duplicates, and formatting issues for correction.

What is the best way to fix broken file paths and duplicate rules in technical docs?

Fixing broken file paths and duplicate rules involves scanning documentation directories to verify references against the actual source code structure, then flagging and correcting formatting inconsistencies and duplicates.

How do I validate documentation integrity using manage-bp-ids.py?

Validate documentation integrity by running the manage-bp-ids.py script with the --validate flag, which checks best practices Markdown files for formatting issues and reference accuracy against the codebase.

Does this documentation audit tool work with Markdown files in a specific repository structure?

This documentation audit tool works specifically with Markdown files located in ./docs/best-practices/ and ./docs/BEST-PRACTICES.md within the brave-core repository, verifying them against the src/ directories.

Why does best practices documentation become outdated or incorrectly formatted?

Best practices documentation becomes outdated when code changes are not reflected in the docs, leading to stale file paths, broken internal links, and duplicate rules that require an automated audit to detect and fix.