Skip to content

docs: optimize AGENTS.md as progressive disclosure map#868

Merged
loonghao merged 1 commit into
mainfrom
docs-update-20260512
May 12, 2026
Merged

docs: optimize AGENTS.md as progressive disclosure map#868
loonghao merged 1 commit into
mainfrom
docs-update-20260512

Conversation

@loonghao
Copy link
Copy Markdown
Owner

Summary

  • Optimize AGENTS.md to be more of a 'map' with progressive disclosure
  • Add prominent Documentation Map table at top for quick navigation
  • Shorten verbose sections and add 'For details, see [link]' notes
  • Remove duplicate 'Global Install Contract' and 'Documentation Map' sections
  • Keep critical rules and key examples for AI agent reference

Changes

  • AGENTS.md: 79 insertions(+), 210 deletions(-)
  • File is now more concise (~500 lines → ~400 lines)
  • All sections point to detailed docs for full information

Checklist

  • CI will pass (format/lint/test)
  • Documentation is consistent (137 providers)
  • No breaking changes

- Add prominent Documentation Map table at top for quick navigation
- Shorten verbose sections (Common Tasks, Code Style, Testing, etc.)
- Add 'For details, see [link]' progressive disclosure notes
- Remove duplicate 'Global Install Contract' section
- Remove duplicate 'Documentation Map' at end of file
- Keep critical rules and key examples for AI agent reference
- All sections now point to detailed docs for full information

Co-Authored-By: CodeBuddy AI <codebuddy@tencent.com>
@loonghao loonghao merged commit abf8fbc into main May 12, 2026
37 checks passed
@loonghao loonghao deleted the docs-update-20260512 branch May 12, 2026 01:08
@github-actions github-actions Bot mentioned this pull request May 12, 2026
loonghao added a commit that referenced this pull request May 26, 2026
- Add prominent Documentation Map table at top for quick navigation
- Shorten verbose sections (Common Tasks, Code Style, Testing, etc.)
- Add 'For details, see [link]' progressive disclosure notes
- Remove duplicate 'Global Install Contract' section
- Remove duplicate 'Documentation Map' at end of file
- Keep critical rules and key examples for AI agent reference
- All sections now point to detailed docs for full information

Co-authored-by: CodeBuddy AI <codebuddy@tencent.com>
loonghao added a commit that referenced this pull request May 26, 2026
- Add prominent Documentation Map table at top for quick navigation
- Shorten verbose sections (Common Tasks, Code Style, Testing, etc.)
- Add 'For details, see [link]' progressive disclosure notes
- Remove duplicate 'Global Install Contract' section
- Remove duplicate 'Documentation Map' at end of file
- Keep critical rules and key examples for AI agent reference
- All sections now point to detailed docs for full information

Co-authored-by: CodeBuddy AI <codebuddy@tencent.com>
This was referenced May 26, 2026
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