fxa-check-docs

Correct grammar, typos, and unclear wording in changed files' documentation.

683|238|Updated Jun 3, 2015
One-click install
npx skills add https://github.com/mozilla/fxa --skill fxa-check-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fxa-check-docs
Source: https://github.com/mozilla/fxa/tree/main/.claude/skills/fxa-check-docs
Command: npx skills add https://github.com/mozilla/fxa --skill fxa-check-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Improves documentation quality for all files changed against main by correcting grammar, typos, and unclear wording.

Core Features & Use Cases

  • Grammar, typos, and clarity improvements across README files, inline comments, and API docs.
  • Improve inline JSDoc/TSDoc comments and maintain consistency in documentation across the codebase.
  • Draft concise changelog summaries and align documentation with code changes.
  • Ensure edits are non-behavioral and made in place, with a clear summary of improvements.

Quick Start

Run a documentation-focused pass on all changed files against main to improve wording without altering code behavior.

Frequently Asked Questions about fxa-check-docs

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

FAQPage Schema
How do I fix typos and grammar in changed files before a pull request?

A documentation pass automatically reviews files changed against main to correct grammar, typos, and unclear wording in READMEs, inline comments, and API docs without altering code behavior.

Can I update JSDoc and TSDoc comments automatically during code review?

Yes, you can polish JSDoc and TSDoc comments during code review by applying in-place edits to changed files, ensuring inline documentation maintains consistency and clarity across the codebase.

What is the best way to generate changelog summaries from code changes?

Drafting concise changelog summaries is achieved by reviewing all files changed against main, aligning documentation updates with code modifications, and outputting a clear summary of improvements.

Does documentation polishing modify functional code behavior?

No, documentation polishing ensures all edits are non-behavioral and made strictly in place, meaning functional code logic remains completely untouched while grammar and clarity are improved.

When do I need to run a README and API documentation clarity check?

You need a README and API documentation clarity check during PR preparation when changed files contain unclear wording, ensuring all documentation is grammatically correct and aligned before merging.