RediSearch / rust-docs-guidelines
Install for your project team
Run this command in your project directory to install the skill for your entire team:
mkdir -p .claude/skills/rust-docs-guidelines && curl -L -o skill.zip "https://fastmcp.me/Skills/Download/1552" && unzip -o skill.zip -d .claude/skills/rust-docs-guidelines && rm skill.zipProject Skills
This skill will be saved in .claude/skills/rust-docs-guidelines/ and checked into git. All team members will have access to it automatically.
Important: Please verify the skill by reviewing its instructions before using it.
Guidelines for writing Rust documentation
0 views
0 installs
Skill Content
--- name: rust-docs-guidelines description: Guidelines for writing Rust documentation. Use this when you want to write Rust documentation. --- # Rust Docs Guidelines Standards to follow when writing Rust documentation. ## Guidelines - Key concepts should be explained only once. All other documentation should use an intra-documentation link to the first explanation. - Always use an intra-documentation link when mentioning a Rust symbol (type, function, constant, etc.). - Avoid referring to specific lines or line ranges, as they may change over time. Use line comments if the documentation needs to be attached to a specific code section inside a function/method body. - Focus on why, not how. In particular, avoid explaining trivial implementation details in line comments. - Refer to constants using intra-documentation links. Don't hard-code their values in the documentation of other items. - Intra-documentation links to private items are preferable to duplication. Add `#[allow(rustdoc::private_intra_doc_links)]` where relevant.