agentsclimarketplace

Docs from code

Skill vishnujchandran/.agents/skills/docs-from-code

A curated collection of reusable AI agent skills, playbooks, and prompts for security audits, engineering workflows, and automation.

Install
npx -y skills add vishnujchandran/.agents --skill docs-from-code

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

  • no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
  • 0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Generate and synchronize documentation from real code, scripts, configs, and tests to prevent documentation drift.

SKILL.md

1.7 KB, 351 tokens by cl100k_base, as published. Nobody here has run it

docs-from-code (v2.0)

Keep README and docs aligned with actual code behavior.

Trigger Signals

Use when user asks to:

  • generate docs from code
  • update stale README/docs after changes
  • document setup, scripts, APIs, env vars, examples
  • prepare release docs quickly and accurately

Source-of-Truth Order

Use this precedence when conflicts exist:

  1. runtime code and handlers
  2. tests/contract tests
  3. config/scripts/package manifests
  4. existing docs

Modes

  • sync-only (default): update docs from verified behavior
  • scaffold-missing: create missing doc sections/templates

Workflow

  1. Inspect source, scripts, configs, interfaces/routes.
  2. Extract verified commands/options/env vars/examples.
  3. Compare with existing docs and detect drift.
  4. Apply minimal doc updates in-place.
  5. Mark uncertain items as Needs confirmation.

Standard Doc Sections

When applicable, maintain:

  • Quick Start
  • Setup & Prerequisites
  • Commands (run/test/build/lint)
  • Configuration & Environment Variables
  • API/Usage Examples
  • Troubleshooting

Output Contract

Return exactly:

  1. Drift summary (stale claim | source | fix)
  2. Updated files list
  3. Verified commands/examples
  4. Remaining manual doc tasks

Verification Rules

  • Never document commands not found in project files or validated in context
  • If command cannot be validated, label clearly as Unverified
  • Never fabricate features or API behavior

Constraints

  • Keep docs concise and copy-paste friendly
  • Preserve project tone/style unless user asks to rewrite
  • Prefer incremental edits over full rewrites

Keep looking

Skills are one crate of 328,083. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.