jim60105/copilot-prompt

rewrite-rustdoc

Rewrite Rust documentation comments to ensure all documentation and comments are in English, following rustdoc guidelines.

First seen Mar 1, 2026

Installation

$ npx skills add jim60105/copilot-prompt --skill rewrite-rustdoc

Summary

  • Rewrite Rust documentation comments to ensure all documentation and comments are in English, following rustdoc guidelines.
  • Use when the user wants to clean up Rust documentation, translate Chinese comments to English, fix missing documentation, or ensure rustdoc compliance in a Rust codebase.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from jim60105/copilot-prompt · top by installs.

npx skills add jim60105/copilot-prompt

Browse all from jim60105/copilot-prompt

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 21
License LICENSE
Default branch master
Status Active

Skill metadata

Parsed from SKILL.md frontmatter.

LicenseGFDL-1.3-or-later
More metadata

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,817 B
  • docs SUMMARY.md 316 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 15 installs

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.

  1. 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.

  1. Search for Chinese characters in the source code:

``bash rg -n "[\u4e00-\u9fff]" src/ ` Check for missing documentation: `bash cd src/ && cargo clippy -- -W missing_docs ` Replace src/` with the user-specified location if provided.

  1. Refer to ./docs/rustdoc-guidelines.md for documentation structure and style standards.
  1. Ensure all corrections adhere strictly to the documentation guidelines.
  1. 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.