Skip to content

docs: add AGENTS.md to help AI coding tools understand the repo#926

Open
OwnOptic wants to merge 1 commit intomicrosoft:mainfrom
OwnOptic:add-agents-md
Open

docs: add AGENTS.md to help AI coding tools understand the repo#926
OwnOptic wants to merge 1 commit intomicrosoft:mainfrom
OwnOptic:add-agents-md

Conversation

@OwnOptic
Copy link
Copy Markdown
Contributor

@OwnOptic OwnOptic commented May 1, 2026

Summary

Closes #710

Adds an AGENTS.md file to the root of the repository. This is a standard convention that helps AI coding assistants (GitHub Copilot, Claude Code, Cursor, etc.) understand the repository structure, conventions, and workflows without needing to explore the entire codebase.

What's included

  • Repository structure overview (docs/, src/, mkdocs.yml, etc.)
  • Lab naming convention table (E, BMA, BAF, MCS, MAB, MSA prefixes explained)
  • How to run the docs site locally (mkdocs serve + Docker alternative)
  • How to add or edit lab content (nav registration, snippets, admonitions)
  • JavaScript files and their purpose (cc-award.js, cc-next.js, etc.)
  • i18n guidance for Japanese translations
  • Contribution checklist (CLA, no secrets, mkdocs serves clean)
  • Key links (issues, discussions, awards, recognition program, sample gallery)

Test plan

  • mkdocs serve still runs without errors (no change to docs content)
  • File renders cleanly on GitHub (tables, code blocks, headings)

@OwnOptic
Copy link
Copy Markdown
Contributor Author

OwnOptic commented May 1, 2026

@microsoft-github-policy-service agree [company="{Witivio}"]

@OwnOptic
Copy link
Copy Markdown
Contributor Author

OwnOptic commented May 1, 2026

@microsoft-github-policy-service agree

@rabwill
Copy link
Copy Markdown
Collaborator

rabwill commented May 4, 2026

Thank you for the suggestion, the team as a whole will look into significant changes in the repo. Holding this off for now.

@rabwill rabwill added the on hold Wait to fix until a platform or tool change is available label May 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

on hold Wait to fix until a platform or tool change is available

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md file

2 participants