Skip to content

Commit 774eeb5

Browse files
authored
Add AGENTS.md to the repository (#28651)
1 parent 006641a commit 774eeb5

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Agent Quick Guide
2+
3+
Top-level entrypoint for agents working in this repository.
4+
5+
## Authority
6+
7+
If this file and `.github/copilot-instructions.md` ever differ, follow:
8+
9+
1. `.github/copilot-instructions.md`
10+
2. The prompt and template files it routes you to
11+
12+
This file is intentionally thin to avoid split-brain guidance.
13+
14+
## Read first
15+
16+
Before doing docs work in this repo:
17+
18+
1. Read `.github/copilot-instructions.md`
19+
2. Determine whether the task is **authoring/updating** or **review**
20+
3. Load the prompt file that `.github/copilot-instructions.md` tells you to read first
21+
22+
## Repo map
23+
24+
- `api-reference/*/api/` — API operation topics
25+
- `api-reference/*/resources/` — resource and enum topics
26+
- `changelog/` — API change records
27+
- `concepts/whats-new-overview.md` — monthly release highlights
28+
- `concepts/` — conceptual topics such as tutorials, conceptual overviews, guides
29+
- `api-reference/*/toc/toc.mapping.json` — API reference TOC mapping
30+
- `api-reference/*/includes/rbac-for-apis/` — RBAC include files
31+
- `temp-docstubs/` — temporary authoring inputs
32+
33+
## Workflow
34+
35+
1. Start with `.github/copilot-instructions.md`
36+
2. Load the correct scenario guidance
37+
3. Make scoped changes only
38+
4. Run the validation expected by the loaded workflow
39+
40+
## Rule of thumb
41+
42+
Do not duplicate detailed rules in this file. Keep detailed authoring, review, changelog, What's New, TOC, enum, and RBAC guidance in the files referenced by `.github/copilot-instructions.md`.

0 commit comments

Comments
 (0)