clean-docs

A documentation-cleanup guide for Markdown and text files, covering structure, commands, examples, links, and formatting.

In plain words
What is it for?
Use it to update READMEs, AGENTS.md, project documentation, skill files, or agent files. It checks command accuracy, internal links, Markdown hygiene, and unwanted em dashes.
Why use it?
It removes stale, unclear, or broken documentation details that make instructions harder to follow or parse.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/urmzd/dotfiles/clean-docs
Any agent
npx skills add urmzd/dotfiles --skill clean-docs
Clone the repo
git clone --depth 1 https://github.com/urmzd/dotfiles

Made for: Claude Code, Codex.

Per session 84 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,156 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00084 $0.01156
Opus 5 $0.00042 $0.00578
Sonnet 5 $0.00017 $0.00231
Haiku 4.5 $0.00008 $0.00116

Measured 2d ago against content hash 54872d0c1251, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

clean-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

dot_agents/skills/clean-docs/SKILL.md · 110 lines

How it starts

The opening of the file, as written. The whole thing — 110 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Clean Docs

Clean documentation so users can act on it quickly and agents can parse it reliably.

When to Use

  • The user invokes /clean-docs.
  • The user asks to clean, polish, modernize, or tighten docs.
  • The user asks for docs to be accurate, up to date, readable, or user-focused.
  • The user asks to remove em dashes, AI-looking prose, stale examples, or formatting drift.
  • The task touches README, AGENTS.md, llms.txt, docs/, skill files, or agent files.

Default Workflow

  1. Inventory docs. Find Markdown and text docs with rg --files -g '*.md' -g '*.mdx' -g '*.txt'.

  2. Run the hygiene gate. Prefer the bundled checker:

    checker="${CLAUDE_SKILL_DIR:-$HOME/.agents/skills}/sync-docs/scripts/check-doc-hygiene.sh"
    "$checker" .
    

    In a chezmoi source tree before apply, use:

    dot_agents/skills/sync-docs/scripts/executable_check-doc-hygiene.sh .
    
  3. Verify claims before editing. Check commands with --help, manifests, source files, tests, and existing configuration. Do not preserve claims that cannot be verified.

  4. Edit in place. Improve structure, wording, examples, and links. Keep the existing document's purpose and do not invent unsupported features.

  5. Rerun the gate. Fix failures until text hygiene, embedded examples, and agentspec validation pass.

  6. Report changes. Summarize files changed, facts verified, and any items that still need a human decision.

Cleanup Rules

Rule Standard
No em dashes Do not use U+2014 anywhere in text, comments, help output, or docs. Use periods, colons, commas, or indexed bullets.
User-first Lead with what the user can do, then prerequisites, then edge cases.
Accurate Commands, paths, flags, and tool names must match current source or CLI help.
Focused Remove filler, repeated setup prose, trailing summaries, and unsupported claims.
Scannable Prefer short sections, tables for matrices, bullets for steps, and fenced code with language tags.
Actionable Every major section should help users install, configure, run, verify, troubleshoot, or extend.

Read the full file on GitHub · 110 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 110 lines · 84 tokens per session scan A 54872d0c1251

Subscribe to this mod's changes

clean-docs is a skill published in the GitHub repository urmzd/dotfiles (3 stars, last pushed 20d ago), licensed Apache-2.0. It adds 84 tokens to every session and 1,156 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

benchling-integration

Benchling Python SDK and REST API integration for registry entities, inventory, ELN entries, workflows, Benchling Apps, and Data Warehouse queries. Use when automating lab data with benchling-sdk or the v2 API.

magic3007/dotfiles · 50 tokens

astropy

Core Python library for astronomy and astrophysics workflows that need Astropy APIs, including units/quantities, coordinates, FITS I/O, tables, time systems, WCS, and cosmology. Use when implementing or debugging astronomical data analysis code with Astropy.

magic3007/dotfiles · 56 tokens

esm

Comprehensive toolkit for EvolutionaryScale protein language models including ESM3 (generative multimodal design across sequence, structure, and function) and ESM C (efficient embeddings). Use for protein sequence/structure/function tasks, inverse folding, embeddings, variant design, and ESMFold2 structure prediction…

magic3007/dotfiles · 96 tokens

create-pr

Rebase from the latest origin/main, squash the commits from it, and then create a PR on github with intelligent commit messages based on staged changes.

magic3007/dotfiles · 34 tokens

mcp-notion-usage-guide

MCP Notion工具使用指南,包含常见问题解决方案和最佳实践。使用当: (1) 访问Notion数据库view URL出现"URL type view not currently supported"错误, (2) 需要获取数据库schema和表结构信息, (3) 查询数据库中的条目内容, (4) 创建页面时MULTISELECT字段值不存在导致失败, (5) 需要更新数据库schema添加新选项, (6) 开发需要集成Notion数据的自动化工作流, (7) querydatasources/query-database-view返回Business Plan要求错误, (8) 需要在无Business…

magic3007/dotfiles · 152 tokens

scan-commit

Automatically scan the repository for unstaged/untracked changes, group them into logical commits using hunk-level analysis, stage and commit them following Conventional Commits.

magic3007/dotfiles · 35 tokens