Skip to content

docs: add AGENTS.md with repository instructions for AI agents#29

Merged
whg517 merged 3 commits into
zncdatadev:mainfrom
whg517:docs/add-agents-md
May 2, 2026
Merged

docs: add AGENTS.md with repository instructions for AI agents#29
whg517 merged 3 commits into
zncdatadev:mainfrom
whg517:docs/add-agents-md

Conversation

@whg517
Copy link
Copy Markdown
Member

@whg517 whg517 commented May 2, 2026

Summary

Add AGENTS.md to provide AI coding agents with project context, development rules,
and CI requirements when working with this repository.

Contents

  • Project overview (Docusaurus 3.10, React 19, TypeScript 5.8)
  • Repository structure and common commands
  • Development rules: pre-PR checklist, doc authoring, sidebar updates, i18n notes
  • Markdown rules (200 char line limit, Mermaid, relative links)
  • Operator documentation template reference
  • Commit message conventions
  • CI checks overview

Testing

  • npm run build passes for both en and zh-Hans locales
  • npx tsc --noEmit passes (no TypeScript errors)
  • No lines exceeding 200 characters in AGENTS.md

whg517 added 3 commits May 2, 2026 17:42
- Fork-based workflow with Git Worktree for parallel development
- Branch naming conventions
- Worktree management conventions
- PR description template
- Pre-PR checklist integration
@whg517 whg517 merged commit 682a69a into zncdatadev:main May 2, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant