Agent skill

Docs Rust Sweep

by mrchantey in mrchantey/beet

Comprehensive public-api quality pass over the core crates, reducing pub visibility and documenting every public item to a deny(missingdocs) standard.

Apache-2.0Auto-check passed

Install Docs Rust Sweep

skills CLI
$ npx skills add mrchantey/beet --skill docs-rust-sweep -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install mrchantey/beet docs-rust-sweep --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/mrchantey/beet.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/docs-rust-sweep .claude/skills/docs-rust-sweep && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
docs-rust-sweep
GitHub stars
135
Token cost
~590 tokens
SKILL.md length
334 words
Files
1
Skills in repo
11
Repo updated
First seen
Licence
Apache-2.0

At a glance

Comprehensive public-api quality pass over the core crates, reducing pub visibility and documenting every public item to a deny(missingdocs) standard.

  • Works in 2 steps: Reduce usage of pub: prefer pub(super),… → Public Docs: ensure all public apis are…
  • Crate-wide documentation
  • SKILL.md covers Task, Conventions, Process and Crates
  • Calls cargo and just

What it does

Docs Rust Sweep is an agent skill from mrchantey/beet. Comprehensive public-api quality pass over the core crates, reducing pub visibility and documenting every public item to a deny(missingdocs) standard. Use for crate-wide documentation or visibility sweeps.

Its SKILL.md is about 590 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It works with Rust. The repository describes itself as: A malleable engine built on interoperable standards. The licence is Apache-2.0.

When your agent uses it

  • Crate-wide documentation
  • Visibility sweeps

Example prompts

  • “/docs-rust-sweep”

Workflow steps

2 steps, taken from the first numbered list in SKILL.md.

  1. Reduce usage of pub: prefer pub(super), pub(crate) etc wherever it makes sense, this includes at the module level and for struct fields.
  2. Public Docs: ensure all public apis are well documented according to RFC 1574, except where it would be overly verbose.

What it can do on your machine

Read from SKILL.md and the folder at commit 38648b8. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • cargo
    • just

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Docs Rust Sweep loads about 590 tokens when it runs. Until then it costs about 56 tokens; SKILL.md has 334 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~56
When it runs · the whole SKILL.md, loaded when a task matches
~590

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from mrchantey/beet at commit 38648b8, republished under its Apache-2.0 licence (© mrchantey). 334 words, ~590 tokens.

Download SKILL.mdSave it as .claude/skills/docs-rust-sweep/SKILL.md (or your agent's skills folder).
name
docs-rust-sweep
description
Comprehensive public-api quality pass over the core crates, reducing pub visibility and documenting every public item to a deny(missing_docs) standard. Use for crate-wide documentation or visibility sweeps.

Rust Doc Sweep

Task

We will now do a comprehensive code quality pass for the core crates of this project.

This task has the primary goal of improving public apis:

  1. Reduce usage of pub: prefer pub(super), pub(crate) etc wherever it makes sense, this includes at the module level and for struct fields.
  2. Public Docs: ensure all public apis are well documented according to RFC 1574, except where it would be overly verbose.

While we are passing through source files we should also consider two secondary goals: 3. Comments: ensure all complex logic explains well its behavior 4. Tests: ensure all tests are of high quality 5. Integration tests and examples: these should also be well documented. examples should be in root directory, not individual crates.

Conventions

  • QUALITY NOT QUANTITY: LLMs love writing text, but if its overly verbose or explaining the obvious, this has a negative value. Ensure only whats needed is used, ie MyStruct::new usually does not need an example, just a one-liner doc. General usage should be in the top level MyStruct docs
  • Many modules will need module-level documentation. try not to duplicate struct docs in the module level. The module level should contain very high level concepts and most modules dont need examples.
  • Do not discard comments, todos unless certain they are no longer relevant

Process

For each crate do the following:

  1. add #![deny(missing_docs)]
  2. add docs until cargo check passes with all features, both native and wasm:
    • cargo check -p beet_core --all-features
    • cargo check -p beet_core --all-features --target wasm32-unknown-unknown
  3. Run doc tests with all features:
  • timeout 1m cargo test -p beet_core --doc --all-features | tail 30
  1. mark the crate as done in the checklist below

Crates

List the workspace crates (ls crates/) here in dependency order at the start of a sweep, basic dependencies first, and check them off as they complete. Skip those marked completed. Do not ask to continue to the next one, just do it.

Finally verify all changes by running: just test-all

© mrchantey, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .agents/skills/docs-rust-sweep of mrchantey/beet.

Open the folder on GitHubat commit 38648b8

Compare with similar skills

Docs Rust Sweep next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Docs Rust Sweep compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Rust Sweep this skillmrchantey/beet135—~590Automated safety check: PassApache-2.0
Update V8 Versionopeninterpreter/openinterpreter69k2 repos~845Automated safety check: PassApache-2.0
Firecrawl Page Scrape Integrationfirecrawl/firecrawl190k1 repos~944Automated safety check: PassISC
Migrate Core Code to Submodulestinyhumansai/openhuman42k—~2.6kAutomated safety check: PassGPL-3.0
Rust TDD Workflowrtk-ai/rtk83k—~753Automated safety check: NotesApache-2.0
Rust Best Practicesfarm-fe/farm5.6k3 repos~1.1kAutomated safety check: PassMIT

Similar skills

  • Update V8 Version

    openinterpreter/openinterpreter

    Bumps the pinned v8 and rusty_v8 versions in Codex, validates the release-candidate path with the v8-canary check, and traces failures to upstream build changes.

    69k GitHub starsUsed in 2 repos~845 tokens
    DevOps & CloudAuto-check passed
  • Adds Firecrawl's /scrape endpoint to application code to pull markdown, HTML, links, screenshots or structured data from a single known URL.

    190k GitHub starsUsed in 1 repo~944 tokens
    Data & AnalyticsAuto-check passed
  • Migrate Core Code to Submodules

    tinyhumansai/openhuman

    Plans and carries out moving non-host-specific code and its tests from the OpenHuman core into vendored tiny submodule libraries, then releases the submodule and re-pins the host.

    42k GitHub stars~2.6k tokensUpdated today
    DevelopmentAuto-check passed
  • Enforces red-green-refactor for Rust work, with idiomatic test patterns, a naming convention and a pre-commit gate of cargo fmt, clippy and test.

    83k GitHub stars~753 tokensUpdated today
    Testing & QAAuto-check: notes
  • Guide for writing idiomatic Rust code based on Apollo GraphQL's best practices handbook.

    5.6k GitHub starsUsed in 3 repos~1.1k tokens
    DevelopmentAuto-check passed
  • Decides whether an OpenLogi device problem on macOS is a privacy-permission (TCC) problem, using agent log lines, and says which identity needs which grant.

    23k GitHub stars~2.5k tokensUpdated 4 days ago
    DevelopmentAuto-check: notes

More from mrchantey/beet

All 11 skills in this repo
  • Downstream Create

    mrchantey/beet

    Scaffold a new beet downstream repo (beet<name, a sibling of this checkout depending on the beet facade by path) from the template, register it with downstream-sync and run the first sync.

    135 GitHub stars~709 tokensUpdated today
    Auto-check passed
  • Test Examples

    mrchantey/beet

    Run the workspace example smoke set to catch regressions unit tests miss, covering every feature gate combination with self-terminating examples and curl-probed servers.

    135 GitHub stars~2.9k tokensUpdated today
    Auto-check passed
  • Test The Works

    mrchantey/beet

    Maximal project health pass. An agent skill from mrchantey/beet.

    135 GitHub stars~1k tokensUpdated today
    Auto-check passed
  • Docs Site

    mrchantey/beet

    Write and edit the public website docs in site/routes/docs (beet.org/docs).

    135 GitHub stars~672 tokensUpdated today
    Auto-check passed
  • Infra Deploy

    mrchantey/beet

    The release process for the beet website. An agent skill from mrchantey/beet.

    135 GitHub stars~16k tokensUpdated today
    Auto-check: warnings
  • Downstream Sync

    mrchantey/beet

    Refresh every downstream repo (beetatproto, beetconnect, beetegress, beetesp, beeteval) with beet's AGENTS.md marker block, its MIT/Apache licenses and shared config files.

    135 GitHub stars~1.1k tokensUpdated today
    Auto-check passed

Works with

Questions about Docs Rust Sweep

What does Docs Rust Sweep do?

Comprehensive public-api quality pass over the core crates, reducing pub visibility and documenting every public item to a deny(missingdocs) standard. Docs Rust Sweep is an agent skill from mrchantey/beet. Comprehensive public-api quality pass over the core crates, reducing pub visibility and documenting every public item to a deny(missingdocs) standard.

When should I use Docs Rust Sweep?

Docs Rust Sweep fits situations like: crate-wide documentation; visibility sweeps.

How do I install Docs Rust Sweep in Claude Code?

Run `npx skills add mrchantey/beet --skill docs-rust-sweep -a claude-code`. Or copy the skill folder (.agents/skills/docs-rust-sweep in mrchantey/beet) into .claude/skills/docs-rust-sweep in your project. Claude Code loads it when a task matches its description.

How do I install Docs Rust Sweep in Codex?

Run `npx skills add mrchantey/beet --skill docs-rust-sweep -a codex`. Or copy the skill folder (.agents/skills/docs-rust-sweep in mrchantey/beet) into .agents/skills/docs-rust-sweep in your project. Codex loads it when a task matches its description.

Can I use Docs Rust Sweep in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add mrchantey/beet --skill docs-rust-sweep -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-rust-sweep, .gemini/skills/docs-rust-sweep, .github/skills/docs-rust-sweep and .opencode/skills/docs-rust-sweep in your project.

What does Docs Rust Sweep need to run?

Going by SKILL.md and its folder, Docs Rust Sweep needs the command-line tools its instructions call (cargo and just).

Does Docs Rust Sweep access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Docs Rust Sweep safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Docs Rust Sweep use?

Docs Rust Sweep is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Docs Rust Sweep use?

About 590 tokens (SKILL.md is roughly 2.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Docs Rust Sweep?

Skills that share tags, products or a category with Docs Rust Sweep: Update V8 Version (openinterpreter/openinterpreter, 69k stars), Firecrawl Page Scrape Integration (firecrawl/firecrawl, 190k stars), Migrate Core Code to Submodules (tinyhumansai/openhuman, 42k stars) and Rust TDD Workflow (rtk-ai/rtk, 83k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Rust Sweep?

mrchantey (a GitHub user) maintains it in mrchantey/beet, which has 135 GitHub stars. The repository holds 11 skills in this directory. The repository was last updated on October 7, 2026.

Source: mrchantey/beet on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.