jim60105/rewrite-rustdoc
skills/rewrite-rustdoc/SKILL.md
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.
$ install --global
skillsauthnpx skillsauth add jim60105/copilot-prompt rewrite-rustdocInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: May 26, 2026, 7:46 AM117.0s1 file scanned
SKILL.md
- name:
- rewrite-rustdoc
- description:
- 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.
- license:
- GFDL-1.3-or-later
- author:
- [email protected]
Rewrite Rustdoc
Ensure all Rust documentation and comments are exclusively written in English, following rustdoc guidelines.
Steps
-
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.
-
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.
-
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. -
Refer to
./docs/rustdoc-guidelines.mdfor documentation structure and style standards. -
Ensure all corrections adhere strictly to the documentation guidelines.
-
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.
Related Skills
jim60105/documentation-writer
development
VerifiedTrustedCommunity
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.
19SKILL.mdUpdated May 29, 2026
jim60105/doc-coauthoring
testing
VerifiedTrustedCommunity
Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
19SKILL.mdUpdated May 29, 2026
jim60105/docsify
tools
VerifiedTrustedCommunity
Comprehensive guide for building, configuring, customizing, and deploying Docsify documentation sites. Use when the user wants to (1) initialize a new Docsify site, (2) add or organize Markdown pages, sidebars, navbars, or cover pages, (3) configure `window.$docsify` options, (4) customize themes / CSS variables / fonts, (5) install built-in or third-party Docsify plugins (search, GA, emoji, zoom, copy-code, comments, pagination, tabs, etc.), (6) write a custom Docsify plugin using lifecycle hooks, (7) use Docsify Markdown helpers (callouts, link attributes, image attributes, heading IDs, task lists, embed files with `:include`), (8) deploy to GitHub Pages, GitLab Pages, Netlify, Vercel, Firebase, Docker, Nginx, etc., (9) enable PWA / offline mode, virtual routes, or Vue compatibility, or (10) upgrade a Docsify site from v4 to v5. Triggers on mentions of "docsify", "_sidebar.md", "_navbar.md", "_coverpage.md", "$docsify", or `docsify-cli`.
19SKILL.mdUpdated May 28, 2026
jim60105/chinese-content-writing-guideline
testing
VerifiedTrustedCommunity
Writing guidelines for producing high-quality Traditional Chinese (zh-TW) content. Use when writing any kind of content. Including blog posts, notes, technical articles, technical writing, chitchat, social media posts, etc., even when you are just sending a text message. Also use when reviewing or editing existing Chinese content for tone, style, and terminology compliance.
19SKILL.mdUpdated Apr 6, 2026