Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@
{
"name": "agent-ready",
"source": "./plugins/agent-ready",
"description": "Make a codebase agent-ready by scaffolding CLAUDE.md, ARCHITECTURE.md, and docs/ structure following progressive disclosure patterns",
"version": "1.0.0"
"description": "Make a codebase agent-ready by scaffolding AGENTS.md, ARCHITECTURE.md, and docs/ structure following progressive disclosure patterns. Creates CLAUDE.md as a symlink for Claude Code compatibility.",
"version": "1.1.0"
}
]
}
5 changes: 3 additions & 2 deletions plugins/agent-ready/.claude-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "agent-ready",
"version": "1.0.0",
"description": "Make a codebase agent-ready by scaffolding CLAUDE.md, ARCHITECTURE.md, and docs/ structure following progressive disclosure patterns",
"version": "1.1.0",
"description": "Make a codebase agent-ready by scaffolding AGENTS.md, ARCHITECTURE.md, and docs/ structure following progressive disclosure patterns. Creates CLAUDE.md as a symlink for Claude Code compatibility.",
"author": {
"name": "Damian Galarza",
"url": "https://www.damiangalarza.com"
Expand All @@ -13,6 +13,7 @@
"agents",
"documentation",
"architecture",
"agents-md",
"claude-md",
"progressive-disclosure",
"scaffolding"
Expand Down
17 changes: 13 additions & 4 deletions plugins/agent-ready/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# agent-ready

Make a codebase agent-ready by scaffolding CLAUDE.md, ARCHITECTURE.md, and docs/ structure following progressive disclosure patterns.
Make a codebase agent-ready by scaffolding AGENTS.md, ARCHITECTURE.md, and docs/ structure following progressive disclosure patterns.

This is the **remediation companion** to [codebase-readiness](../codebase-readiness/). While codebase-readiness *scores* how agent-ready your codebase is, agent-ready *fixes* the gaps by generating the documentation and structural artifacts that make a codebase legible to AI agents.

Expand All @@ -15,18 +15,27 @@ This is the **remediation companion** to [codebase-readiness](../codebase-readin

| Mode | What It Does | Example Prompt |
|------|-------------|----------------|
| **scaffold** | Full documentation setup: docs/ structure, ARCHITECTURE.md, CLAUDE.md, starter ADR | "Make this codebase agent-ready" |
| **scaffold** | Full documentation setup: docs/ structure, ARCHITECTURE.md, AGENTS.md, CLAUDE.md symlink, starter ADR | "Make this codebase agent-ready" |
| **architecture** | Generate ARCHITECTURE.md from actual codebase analysis | "Create an ARCHITECTURE.md" |
| **claude-md** | Create or refactor CLAUDE.md for progressive disclosure | "Set up CLAUDE.md" |
| **agents-md** | Create or refactor AGENTS.md for progressive disclosure, create CLAUDE.md symlink | "Set up AGENTS.md" |
| **audit** | Check existing agent-readiness artifacts for staleness and coherence | "Are my agent docs up to date?" |

## Principles

Built on two key sources:

- **Harness Engineering (OpenAI)** -- repository as system of record, progressive disclosure, CLAUDE.md as table of contents not encyclopedia, enforce invariants not implementations
- **Harness Engineering (OpenAI)** -- repository as system of record, progressive disclosure, AGENTS.md as table of contents not encyclopedia, enforce invariants not implementations
- **matklad's ARCHITECTURE.md** -- bird's-eye codemap, name important modules, call out invariants (especially absences), point out boundaries

## AGENTS.md vs CLAUDE.md

This plugin generates **AGENTS.md** as the primary documentation file, which works with any AI coding agent that supports the AGENTS.md convention. For backward compatibility with Claude Code, it also creates **CLAUDE.md as a symlink** to AGENTS.md.

This approach ensures:
- Your documentation works with any AI coding agent
- Claude Code users have seamless compatibility
- You maintain a single source of truth (AGENTS.md)

## Integration with codebase-readiness

If an `AGENT_READY_ASSESSMENT.md` exists from a prior codebase-readiness assessment, agent-ready will read it and auto-suggest which mode to run first based on the weakest dimensions.
Expand Down
Loading
Loading