fix: flip symlink structure - AGENTS.md is the real file

AGENTS.md is now the canonical instruction file, with CLAUDE.md,
.cursorrules, and .github/copilot-instructions.md as symlinks to it.

This is simpler and more intuitive - the main file is at the root,
not buried in .github/.

Updated all references across agents, commands, skills, and .memory/.
This commit is contained in:
2026-03-09 12:34:26 +00:00
parent fd5bdd6b0b
commit 33180d6e04
12 changed files with 49 additions and 98 deletions

View File

@@ -34,23 +34,23 @@ Be specific in summaries: include parameter names, defaults, file locations, and
## Cross-Tool Instruction Files
Use symlinks to share ONE instruction file across all agentic coding tools:
Use symlinks to share this instruction file across all agentic coding tools:
```text
project/
├── .github/
│ └── copilot-instructions.md # Real file (edit this one)
├── AGENTS.md -> .github/copilot-instructions.md
── CLAUDE.md -> .github/copilot-instructions.md
└── .cursorrules -> .github/copilot-instructions.md
├── AGENTS.md # Real file (edit this one)
├── CLAUDE.md -> AGENTS.md
├── .cursorrules -> AGENTS.md
── .github/
└── copilot-instructions.md -> ../AGENTS.md
```
**Rules:**
- Edit `.github/copilot-instructions.md` — changes propagate automatically via symlinks
- Edit `AGENTS.md` — changes propagate automatically via symlinks
- Never edit symlinked files directly (changes would be lost)
- Symlinks are committed to git (git tracks them natively)
**Content of the instruction file:**
**Content of this file:**
- Project overview and purpose
- Tech stack and architecture
- Coding conventions and patterns
@@ -60,12 +60,12 @@ project/
**Do NOT duplicate `.memory/` contents** — instruction files describe how to work with the project, not active plans, research, or decisions.
**When initializing a project:**
1. Create `.github/copilot-instructions.md` with project basics
2. Create symlinks: `ln -s .github/copilot-instructions.md AGENTS.md` (etc.)
1. Create `AGENTS.md` with project basics
2. Create symlinks: `ln -s AGENTS.md CLAUDE.md`, `ln -s AGENTS.md .cursorrules`, `ln -s ../AGENTS.md .github/copilot-instructions.md`
3. Commit the real file and symlinks to git
**When joining an existing project:**
- Read `.github/copilot-instructions.md` (or any of the symlinked files) to understand the project
- Read `AGENTS.md` (or any of the symlinked files) to understand the project
- If instruction file is missing, create it and the symlinks
## Session Continuity