rewrite-rustdoc

SKILL.md

Rewrite Rustdoc

Ensure all Rust documentation and comments are exclusively written in English, following rustdoc guidelines.

Steps

  1. Determine which files to process:

    • If the user provides a method to find files, use that method.
    • Otherwise, assume files are in the src/ directory.
    • Proceed immediately to the next steps after acquiring file information.
  2. Conduct a comprehensive review to ensure all documentation and comments are in English.

    • Any Chinese text in documentation or code comments must be identified and corrected.
    • Chinese characters in test case strings are permissible and do not require modification.
    • Chinese report files should not be modified — focus on Rust source code files only.
  3. Search for Chinese characters in the source code:

    rg -n "[\u4e00-\u9fff]" src/
    

    Check for missing documentation:

    cd src/ && cargo clippy -- -W missing_docs
    

    Replace src/ with the user-specified location if provided.

  4. Refer to ./docs/rustdoc-guidelines.md for documentation structure and style standards.

  5. Ensure all corrections adhere strictly to the documentation guidelines.

  6. Repeat the search and revision process iteratively until no further occurrences require modification.

    • Do not prompt for confirmation before proceeding to the next item.
    • Complete all necessary changes before reporting back.
Weekly Installs
8
GitHub Stars
18
First Seen
Mar 1, 2026
Installed on
opencode8
gemini-cli8
codebuddy8
github-copilot8
codex8
kimi-cli8