fix-docs

Updates and archives stale Markdown documentation in lib/iris, lib/zephyr, and lib/fray.

3.2k|266|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/marin-community/marin --skill fix-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fix-docs
Source: https://github.com/marin-community/marin/tree/main/.agents/skills/fix-docs
Command: npx skills add https://github.com/marin-community/marin --skill fix-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation in the Marin repository drifts out of sync with the code, confusing coding agents that rely on docs as their primary context source. This Skill de-rots Markdown docs in lib/iris, lib/zephyr, and lib/fray by updating or archiving outdated content.

Core Features & Use Cases

  • Scoped doc repair: Fixes Markdown only within lib/iris, lib/zephyr, and lib/fray, never touching docs outside those directories.
  • Rot handling: Updates recently changed docs in place or archives historical-only design docs to .agents/projects/<YYYYMMDD>_<filename>.md, dated from the first git commit.
  • Agent-oriented standards: Enforces AGENTS.md, OPS.md, and SKILL.md conventions so agents know where to find token-efficient documentation.
  • Use Case: After a refactor of the iris library, ask the agent to fix the docs; it dispatches sub-agents to parse code and docs, applies corrections, and commits everything as a single local commit.

Quick Start

Ask the agent to fix the outdated documentation in lib/iris, lib/zephyr, and lib/fray and commit the changes locally.

Frequently Asked Questions about fix-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix outdated Markdown documentation in the Marin repo?

Invoke the fix-docs skill explicitly and it will dispatch sub-agents to parse the code and docs in lib/iris, lib/zephyr, and lib/fray, apply corrections, and commit the result as a single local commit. It never pushes without your approval.

Which directories does the fix-docs skill modify?

It only touches Markdown docs under lib/iris, lib/zephyr, and lib/fray. Documentation outside those directories, such as the top-level docs/ folder, is explicitly left untouched.

What happens to stale design docs that are no longer relevant?

Historical-only design docs are archived to .agents/projects/<YYYYMMDD>_<filename>.md, with the date taken from the file's first git commit. Docs that are recent and only slightly out of date are updated in place instead.

Does fix-docs push changes to the remote repository?

No. The skill commits changes into a single local commit, informs the user, and summarizes what changed. It never pushes without explicit user approval.

When should I not use the fix-docs skill?

Do not use it for docs outside lib/iris, lib/zephyr, and lib/fray, or without an explicit request, since the skill is designed to run only when explicitly asked. Human-facing getting-started docs belong in docs/ and follow different conventions.