entry-docs

Installation
SKILL.md

Entry Docs

Outcome

Produce or improve the repo's two entrypoint files so each serves its reader and neither becomes a dump:

  • README.md — human consumers deciding whether and how to use the project
  • AGENTS.md — coding agents on every request. Canonical agent file. Claude Code reads it directly when no CLAUDE.md is on the path; a CLAUDE.md exists only under Claude Code loading in references/agents-md.md, never as a second body of rules

They share a shape, not a template: as short as they can be without being shorter, with depth behind pointers. They are complementary, not mirrors. One-liner project description is the only intended overlap.

Sources this skill distills (do not paste them in): A Complete Guide To AGENTS.md, How Claude remembers your project, and Art of README (CC BY 2.0, Kira / hackergrrl).

Mode

Choose the narrowest match. If the user names one file, do not rewrite the other.

Installs
1
GitHub Stars
4
First Seen
13 days ago