wiki-agents-md

Topics in the source

• AGENTS.md Generator
• What is AGENTS.md
• Critical Guard: Only Generate If Missing
• Pertinent Folder Detection
• Always generate for:
• Generate if they exist:
• Always skip:
• The Six Core Areas

Generate high-quality AGENTS.md files for repository folders. Each file provides coding agents with project-specific context — build commands, testing instructions, code style, structure, and operational boundaries. AGENTS.md complements README.md. README is for humans; AGENTS.md is for coding agents. Predictable location — Agents look for AGENTS.md in the current directory, then walk up the tree Nested files — Subfolders can have their own AGENTS.md that takes precedence over the root one Separate from README — Keeps READMEs concise; agent-specific details (exact commands, boundaries, conventions) go here NOT the same as .github/agents/.agent.md — Those are agent persona definitions (who the agent is). AGENTS.md is project context (what the agent should know about this code) This is the single most important rule. NEVER overwrite an existing AGENTS.md. Before generating for ANY folder: If it exists → skip and report: "AGENTS.md already exists at — skipping" If it does not exist → proceed with generation This check applies to every folder independently Identify which folders should have an AGENTS.md: Repository root (/) Wiki folder (wiki/) — if generated by deep-wiki (has package.j

This is an excerpt. Refer to the complete source and its current requirements.