
Rewrite Rustdoc
- 13 installs
- 21 repo stars
- Updated July 31, 2026
- jim60105/copilot-prompt
Rewrite Rust documentation and comments so all are in English, translating Chinese text and fixing missing docs per rustdoc guidelines.
About
Reviews Rust source files to ensure documentation and comments are exclusively English, translating Chinese and filling missing docs. A developer uses it to enforce rustdoc compliance and consistent English docs in a Rust codebase.
- Uses ripgrep to find Chinese characters and clippy -W missing_docs
- Leaves test-case strings and Chinese report files untouched
Rewrite Rustdoc by the numbers
- 13 all-time installs (skills.sh)
- Ranked #85 of 121 Rust skills by installs in the Skillselion catalog
- Data as of Aug 2, 2026 (Skillselion catalog sync)
npx skills add https://github.com/jim60105/copilot-prompt --skill rewrite-rustdocAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 13 |
|---|---|
| repo stars | ★ 21 |
| Last updated | July 31, 2026 |
| Repository | jim60105/copilot-prompt ↗ |
What it does
Rewrite Rust documentation and comments so all are in English, translating Chinese text and fixing missing docs per rustdoc guidelines.
Files
Rewrite Rustdoc
Ensure all Rust documentation and comments are exclusively written in English, following rustdoc guidelines.
Steps
0. 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.
2. Search for Chinese characters in the source code:
rg -n "[\u4e00-\u9fff]" src/Check for missing documentation:
cd src/ && cargo clippy -- -W missing_docsReplace src/ with the user-specified location if provided.
3. Refer to ./docs/rustdoc-guidelines.md for documentation structure and style standards.
4. Ensure all corrections adhere strictly to the documentation guidelines.
5. 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.