[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"skill:01M77T6XCT2F31JN53C4PRMVPP":3,"skill-same:01M77T6XCT2F31JN53C4PRMVPP":82},{"skillNo":4,"name":5,"nameZh":6,"description":7,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":15,"licenseFileUrl":6,"sourceHtmlUrl":16,"categories":17,"keywords":18,"publishedAt":19,"linkOnly":20,"markdownContent":21,"markdownBody":22,"frontMatter":23,"refName":38,"commitSha":39,"skillDirectory":40,"forksCount":41,"repositoryHtmlUrl":42,"repositoryHomepageUrl":6,"ownerHtmlUrl":43,"ownerBlogUrl":44,"ownerDescription":6,"updatedAt":45,"install":46,"resources":59},"01M77T6XCT2F31JN53C4PRMVPP","documenting-rust-code",null,"Rust documentation practices for HASH codebase. Use when writing doc comments, documenting functions\u002Ftypes\u002Ftraits\u002Fmodules, creating error sections, using intra-doc links, or following rustdoc conventions.","vdcworkshop\u002FSkills-Catalog","vdcworkshop","https:\u002F\u002Favatars.githubusercontent.com\u002Fu\u002F275270998?v=4","01M77R8FXSKYTB2X9SSVJN7ZRZ","αtef βouafif","01M77R8FYGECN2YWM6WVBVPMGS",1,"AGPL-3.0","https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F03 Development\u002F99 Uncategorized\u002Fdocumenting-rust-code\u002FSKILL.md",[],[],"2026-11-15 14:19:17",false,"---\nname: documenting-rust-code\ndescription: Rust documentation practices for HASH codebase. Use when writing doc comments, documenting functions\u002Ftypes\u002Ftraits\u002Fmodules, creating error sections, using intra-doc links, or following rustdoc conventions.\nlicense: AGPL-3.0\nmetadata:\n  triggers:\n    type: domain\n    enforcement: suggest\n    priority: high\n    keywords:\n      - rustdoc\n      - doc comment\n      - documentation\n      - intra-doc link\n    intent-patterns:\n      - \"\\\\bdocument(ing|ation)?\\\\b.*?\\\\b(rust|function|type|struct|enum|trait|module)\\\\b\"\n      - \"\\\\b(write|add|create)\\\\b.*?\\\\bdoc\\\\s*comment\\\\b\"\n      - \"\\\\b#\\\\s*(Errors|Panics|Examples|Arguments)\\\\b\"\n---\n\n# Rust Documentation Practices\n\nComprehensive guidance on documenting Rust code in the HASH repository following rustdoc conventions.\n\n## Core Principles\n\n**Follow high-quality standards like `time`, `jiff`, and `serde`:**\n\n✅ **DO:**\n\n- Begin every doc comment with single-line summary\n- Use intra-doc links for all type references\n- Document all error conditions with `# Errors`\n- Include practical examples for public APIs\n- Link standard library types: [`Vec`], [`HashMap`], etc.\n- Use inline parameter descriptions for simple functions (0-2 params)\n- Describe return values in main text, not separate sections\n\n❌ **DON'T:**\n\n- Document standard trait implementations (`Debug`, `Display`, `From`)\n- Add separate `# Returns` sections (inline instead)\n- Mention variable types already in signatures\n- Use comments on same line as code\n- Skip error documentation for fallible functions\n\n## Quick Reference\n\n### Basic Doc Comment\n\n```rust\n\u002F\u002F\u002F Retrieves an entity by its UUID.\n\u002F\u002F\u002F\n\u002F\u002F\u002F Loads the entity from the store and verifies access permissions.\n\u002F\u002F\u002F Returns the [`Entity`] if found and accessible.\n\u002F\u002F\u002F\n\u002F\u002F\u002F # Errors\n\u002F\u002F\u002F\n\u002F\u002F\u002F - [`NotFound`] if the entity doesn't exist\n\u002F\u002F\u002F - [`AuthorizationError`] if access is denied\n\u002F\u002F\u002F\n\u002F\u002F\u002F [`NotFound`]: EntityError::NotFound\n\u002F\u002F\u002F [`AuthorizationError`]: EntityError::Authorization\npub fn get_entity(&self, id: EntityId) -> Result\u003CEntity, Report\u003CEntityError>> {\n```\n\n### Intra-Doc Links\n\n```rust\n\u002F\u002F\u002F Updates the [`User`] using [`UserUpdateStrategy`].\n\u002F\u002F\u002F\n\u002F\u002F\u002F See [`validation::user`] for validation rules.\n\u002F\u002F\u002F\n\u002F\u002F\u002F [`validation::user`]: crate::validation::user\n```\n\n## Documentation Patterns\n\n### Simple Functions (0-2 params)\n\nDescribe parameters inline:\n\n```rust\n\u002F\u002F\u002F Processes the `input` elements and returns filtered results.\n\u002F\u002F\u002F\n\u002F\u002F\u002F Takes a collection of `input` elements, applies the `filter_fn`,\n\u002F\u002F\u002F and returns a [`Vec`] containing only matching elements.\n```\n\n### Complex Functions (3+ params)\n\nUse explicit `# Arguments` section:\n\n```rust\n\u002F\u002F\u002F Merges multiple data sources with transformation rules.\n\u002F\u002F\u002F\n\u002F\u002F\u002F # Arguments\n\u002F\u002F\u002F\n\u002F\u002F\u002F * `sources` - Collection of data sources to merge\n\u002F\u002F\u002F * `rules` - Transformation rules to apply\n\u002F\u002F\u002F * `options` - Configuration controlling merge behavior\n\u002F\u002F\u002F * `callback` - Optional function for each merged item\n```\n\n### Error Documentation\n\n```rust\n\u002F\u002F\u002F # Errors\n\u002F\u002F\u002F\n\u002F\u002F\u002F - [`WebAlreadyExists`] if web ID is taken\n\u002F\u002F\u002F - [`AuthorizationError`] if permission denied\n\u002F\u002F\u002F\n\u002F\u002F\u002F [`WebAlreadyExists`]: WebError::WebAlreadyExists\n\u002F\u002F\u002F [`AuthorizationError`]: WebError::Authorization\n```\n\n### Module Documentation\n\n````rust\n\u002F\u002F! Entity management functionality.\n\u002F\u002F!\n\u002F\u002F! Main types:\n\u002F\u002F! - [`Entity`] - Core entity type\n\u002F\u002F! - [`EntityStore`] - Storage trait\n\u002F\u002F!\n\u002F\u002F! # Examples\n\u002F\u002F!\n\u002F\u002F! ```\n\u002F\u002F! use hash_graph::entity::Entity;\n\u002F\u002F! ```\n````\n\n### Examples with Error Handling\n\n````rust\n\u002F\u002F\u002F # Examples\n\u002F\u002F\u002F\n\u002F\u002F\u002F ```rust\n\u002F\u002F\u002F let entities = get_entities_by_type(type_id)?;\n\u002F\u002F\u002F assert_eq!(entities.len(), 2);\n\u002F\u002F\u002F # Ok::\u003C(), Box\u003Cdyn core::error::Error>>(())\n\u002F\u002F\u002F ```\n````\n\n## Verification\n\n```bash\ncargo doc --no-deps --all-features\n```\n\n## References\n\n- **[references\u002Ffunction-documentation.md](references\u002Ffunction-documentation.md)**: Functions and methods documentation patterns\n- **[references\u002Ftype-documentation.md](references\u002Ftype-documentation.md)**: Types, structs, enums, and traits documentation\n- **[references\u002Ferror-documentation.md](references\u002Ferror-documentation.md)**: Error conditions and panics documentation\n- **[references\u002Fexamples-and-links.md](references\u002Fexamples-and-links.md)**: Examples and intra-doc links usage\n","# Rust Documentation Practices\n\nComprehensive guidance on documenting Rust code in the HASH repository following rustdoc conventions.\n\n## Core Principles\n\n**Follow high-quality standards like `time`, `jiff`, and `serde`:**\n\n✅ **DO:**\n\n- Begin every doc comment with single-line summary\n- Use intra-doc links for all type references\n- Document all error conditions with `# Errors`\n- Include practical examples for public APIs\n- Link standard library types: [`Vec`], [`HashMap`], etc.\n- Use inline parameter descriptions for simple functions (0-2 params)\n- Describe return values in main text, not separate sections\n\n❌ **DON'T:**\n\n- Document standard trait implementations (`Debug`, `Display`, `From`)\n- Add separate `# Returns` sections (inline instead)\n- Mention variable types already in signatures\n- Use comments on same line as code\n- Skip error documentation for fallible functions\n\n## Quick Reference\n\n### Basic Doc Comment\n\n```rust\n\u002F\u002F\u002F Retrieves an entity by its UUID.\n\u002F\u002F\u002F\n\u002F\u002F\u002F Loads the entity from the store and verifies access permissions.\n\u002F\u002F\u002F Returns the [`Entity`] if found and accessible.\n\u002F\u002F\u002F\n\u002F\u002F\u002F # Errors\n\u002F\u002F\u002F\n\u002F\u002F\u002F - [`NotFound`] if the entity doesn't exist\n\u002F\u002F\u002F - [`AuthorizationError`] if access is denied\n\u002F\u002F\u002F\n\u002F\u002F\u002F [`NotFound`]: EntityError::NotFound\n\u002F\u002F\u002F [`AuthorizationError`]: EntityError::Authorization\npub fn get_entity(&self, id: EntityId) -> Result\u003CEntity, Report\u003CEntityError>> {\n```\n\n### Intra-Doc Links\n\n```rust\n\u002F\u002F\u002F Updates the [`User`] using [`UserUpdateStrategy`].\n\u002F\u002F\u002F\n\u002F\u002F\u002F See [`validation::user`] for validation rules.\n\u002F\u002F\u002F\n\u002F\u002F\u002F [`validation::user`]: crate::validation::user\n```\n\n## Documentation Patterns\n\n### Simple Functions (0-2 params)\n\nDescribe parameters inline:\n\n```rust\n\u002F\u002F\u002F Processes the `input` elements and returns filtered results.\n\u002F\u002F\u002F\n\u002F\u002F\u002F Takes a collection of `input` elements, applies the `filter_fn`,\n\u002F\u002F\u002F and returns a [`Vec`] containing only matching elements.\n```\n\n### Complex Functions (3+ params)\n\nUse explicit `# Arguments` section:\n\n```rust\n\u002F\u002F\u002F Merges multiple data sources with transformation rules.\n\u002F\u002F\u002F\n\u002F\u002F\u002F # Arguments\n\u002F\u002F\u002F\n\u002F\u002F\u002F * `sources` - Collection of data sources to merge\n\u002F\u002F\u002F * `rules` - Transformation rules to apply\n\u002F\u002F\u002F * `options` - Configuration controlling merge behavior\n\u002F\u002F\u002F * `callback` - Optional function for each merged item\n```\n\n### Error Documentation\n\n```rust\n\u002F\u002F\u002F # Errors\n\u002F\u002F\u002F\n\u002F\u002F\u002F - [`WebAlreadyExists`] if web ID is taken\n\u002F\u002F\u002F - [`AuthorizationError`] if permission denied\n\u002F\u002F\u002F\n\u002F\u002F\u002F [`WebAlreadyExists`]: WebError::WebAlreadyExists\n\u002F\u002F\u002F [`AuthorizationError`]: WebError::Authorization\n```\n\n### Module Documentation\n\n````rust\n\u002F\u002F! Entity management functionality.\n\u002F\u002F!\n\u002F\u002F! Main types:\n\u002F\u002F! - [`Entity`] - Core entity type\n\u002F\u002F! - [`EntityStore`] - Storage trait\n\u002F\u002F!\n\u002F\u002F! # Examples\n\u002F\u002F!\n\u002F\u002F! ```\n\u002F\u002F! use hash_graph::entity::Entity;\n\u002F\u002F! ```\n````\n\n### Examples with Error Handling\n\n````rust\n\u002F\u002F\u002F # Examples\n\u002F\u002F\u002F\n\u002F\u002F\u002F ```rust\n\u002F\u002F\u002F let entities = get_entities_by_type(type_id)?;\n\u002F\u002F\u002F assert_eq!(entities.len(), 2);\n\u002F\u002F\u002F # Ok::\u003C(), Box\u003Cdyn core::error::Error>>(())\n\u002F\u002F\u002F ```\n````\n\n## Verification\n\n```bash\ncargo doc --no-deps --all-features\n```\n\n## References\n\n- **[references\u002Ffunction-documentation.md](references\u002Ffunction-documentation.md)**: Functions and methods documentation patterns\n- **[references\u002Ftype-documentation.md](references\u002Ftype-documentation.md)**: Types, structs, enums, and traits documentation\n- **[references\u002Ferror-documentation.md](references\u002Ferror-documentation.md)**: Error conditions and panics documentation\n- **[references\u002Fexamples-and-links.md](references\u002Fexamples-and-links.md)**: Examples and intra-doc links usage\n",{"name":5,"license":15,"metadata":24,"description":7},{"triggers":25},{"type":26,"keywords":27,"priority":32,"enforcement":33,"intent-patterns":34},"domain",[28,29,30,31],"rustdoc","doc comment","documentation","intra-doc link","high","suggest",[35,36,37],"\\bdocument(ing|ation)?\\b.*?\\b(rust|function|type|struct|enum|trait|module)\\b","\\b(write|add|create)\\b.*?\\bdoc\\s*comment\\b","\\b#\\s*(Errors|Panics|Examples|Arguments)\\b","main","cd5116e81009ad620d09c7bc8664ce8c37f88a99","03 Development\u002F99 Uncategorized\u002Fdocumenting-rust-code",0,"https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog","https:\u002F\u002Fgithub.com\u002Fvdcworkshop","https:\u002F\u002Fvdcworkshop.com","2026-06-28 03:22:57",{"source":8,"skillName":5,"commands":47,"prompt":57,"zipAvailable":58},[48,51,54],{"tool":49,"command":50},"npx","npx skills add vdcworkshop\u002FSkills-Catalog --skill documenting-rust-code",{"tool":52,"command":53},"bunx","bunx skills add vdcworkshop\u002FSkills-Catalog --skill documenting-rust-code",{"tool":55,"command":56},"pnpm","pnpm dlx skills add vdcworkshop\u002FSkills-Catalog --skill documenting-rust-code","安装技能，技能地址：https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F03 Development\u002F99 Uncategorized\u002Fdocumenting-rust-code\u002FSKILL.md",true,[60,66,70,74,78],{"path":61,"resourceType":62,"resourceTypeDesc":63,"sizeBytes":64,"sourceHtmlUrl":65},"README.md","REFERENCE","参考文档",826,"https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F03 Development\u002F99 Uncategorized\u002Fdocumenting-rust-code\u002FREADME.md",{"path":67,"resourceType":62,"resourceTypeDesc":63,"sizeBytes":68,"sourceHtmlUrl":69},"references\u002Ferror-documentation.md",5087,"https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F03 Development\u002F99 Uncategorized\u002Fdocumenting-rust-code\u002Freferences\u002Ferror-documentation.md",{"path":71,"resourceType":62,"resourceTypeDesc":63,"sizeBytes":72,"sourceHtmlUrl":73},"references\u002Fexamples-and-links.md",6690,"https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F03 Development\u002F99 Uncategorized\u002Fdocumenting-rust-code\u002Freferences\u002Fexamples-and-links.md",{"path":75,"resourceType":62,"resourceTypeDesc":63,"sizeBytes":76,"sourceHtmlUrl":77},"references\u002Ffunction-documentation.md",7280,"https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F03 Development\u002F99 Uncategorized\u002Fdocumenting-rust-code\u002Freferences\u002Ffunction-documentation.md",{"path":79,"resourceType":62,"resourceTypeDesc":63,"sizeBytes":80,"sourceHtmlUrl":81},"references\u002Ftype-documentation.md",5354,"https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F03 Development\u002F99 Uncategorized\u002Fdocumenting-rust-code\u002Freferences\u002Ftype-documentation.md",[83,91,98,106,113,120],{"skillNo":84,"name":85,"nameZh":6,"description":86,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":87,"licenseFileUrl":6,"sourceHtmlUrl":88,"categories":89,"keywords":90,"publishedAt":19},"01M77XBV88FMNX83MKDZMXKQZ2","rhaios-staging","Interact with the Rhaios staging REST API for yield operations. Discover -> prepare -> setup-if-needed -> sign -> execute flow with pluggable signer backend. Triggers on requests involving DeFi yield, vault deposits, redeems, rebalancing, or Rhaios API.","MIT","https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F12 Blockchain\u002F03 DeFi\u002Frhaios-staging\u002FSKILL.md",[],[],{"skillNo":92,"name":93,"nameZh":6,"description":94,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":87,"licenseFileUrl":6,"sourceHtmlUrl":95,"categories":96,"keywords":97,"publishedAt":19},"01M77X7AFQGDCFHC25GQ7V92GZ","git-commit-push","Commit and push repository changes safely. Use when user asks to commit, push, or verify and push current changes.","https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F12 Blockchain\u002F01 Smart Contracts\u002Fgit-commit-push\u002FSKILL.md",[],[],{"skillNo":99,"name":100,"nameZh":6,"description":101,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":102,"licenseFileUrl":6,"sourceHtmlUrl":103,"categories":104,"keywords":105,"publishedAt":19},"01M77X71FJ1KR7PTBPRC7S2241","exec-slurm-compile","Compile TensorRT-LLM on a SLURM cluster. Covers submitting a batch job with a container image, monitoring the job, and verifying the build. Use when the user wants to compile TRT-LLM remotely via SLURM rather than on a local compute node.","Apache-2.0","https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F12 Blockchain\u002F01 Smart Contracts\u002Fexec-slurm-compile\u002FSKILL.md",[],[],{"skillNo":107,"name":108,"nameZh":6,"description":109,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":87,"licenseFileUrl":6,"sourceHtmlUrl":110,"categories":111,"keywords":112,"publishedAt":19},"01M77X4BQJ025SPPGRQ96X72QV","databases","Work with MongoDB (document database, BSON documents, aggregation pipelines, Atlas cloud) and PostgreSQL (relational database, SQL queries, psql CLI, pgAdmin). Use when designing database schemas, writing queries and aggregations, optimizing indexes for performance, performing database migrations, configuring replication and sharding, implementing backup and restore strategies, managing database users and permissions, analyzing query performance, or administering production databases.","https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F11 Databases\u002F03 NoSQL Databases\u002Fdatabases\u002FSKILL.md",[],[],{"skillNo":114,"name":115,"nameZh":6,"description":116,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":87,"licenseFileUrl":6,"sourceHtmlUrl":117,"categories":118,"keywords":119,"publishedAt":19},"01M77WZYZGCV9DK5HA0XCWSK97","toast","Toast — restaurant POS, orders, menus, employees, revenue centers, and reporting.","https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F10 Lifestyle\u002F06 Culinary Arts\u002Ftoast\u002FSKILL.md",[],[],{"skillNo":121,"name":122,"nameZh":6,"description":123,"descriptionZh":6,"repositoryFullName":8,"ownerLogin":9,"ownerAvatarUrl":10,"ownerAccountNo":11,"ownerDisplayName":12,"repositoryNo":13,"starsCount":14,"licenseSpdxId":87,"licenseFileUrl":6,"sourceHtmlUrl":124,"categories":125,"keywords":126,"publishedAt":19},"01M77WYYESVCXT81ERPHM77SA9","k-schoollunch-menu","Use when the user asks for Korean school meal menus (급식 식단) by natural-language education office and school name, via k-skill-proxy NEIS school-search and school-meal routes.","https:\u002F\u002Fgithub.com\u002Fvdcworkshop\u002FSkills-Catalog\u002Fblob\u002Fmain\u002F10 Lifestyle\u002F06 Culinary Arts\u002Fk-schoollunch-menu\u002FSKILL.md",[],[]]