Skip to content

docs: add directory-specific AGENTS.md files and improve root guidelines#124

Merged
benvinegar merged 1 commit into
mainfrom
bentlegen/agent-guidelines
Feb 22, 2026
Merged

docs: add directory-specific AGENTS.md files and improve root guidelines#124
benvinegar merged 1 commit into
mainfrom
bentlegen/agent-guidelines

Conversation

@benvinegar
Copy link
Copy Markdown
Member

Summary

  • Root AGENTS.md: Added "How Baudbot works" architecture overview with data flow diagram and deployment model. Expanded directory listing to cover pi/skills/, test/, hooks/, .github/, .env.schema, and bootstrap.sh. Replaced vague guardrails with explicit hard constraints (pre-commit hook, CI) vs strong defaults. Removed redundant "Architecture model" section. Trimmed explanations the agent already knows.
  • bin/AGENTS.md (new): Focus areas, rules, security-critical file list, co-located test notes, validation commands.
  • pi/extensions/AGENTS.md (new): Focus areas, rules, subdirectory extensions (kernel/, agentmail/, email-monitor/), critical files, validation commands.
  • slack-bridge/AGENTS.md (new): Focus areas, rules, key files inventory, security-critical files (added crypto.mjs/crypto.test.mjs), validation commands.

Restructure agent guidelines with concise architecture overview,
directory-specific rules for bin/, pi/extensions/, and slack-bridge/,
and sharper hard vs soft constraint language.
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Feb 22, 2026

Greptile Summary

Restructured agent documentation by creating directory-specific AGENTS.md files and streamlining the root guide. The root AGENTS.md now provides a clearer architecture overview with visual data flow, expanded directory coverage, and explicit constraints. The new directory-specific guides (bin/, pi/extensions/, slack-bridge/) provide focused, actionable rules for each area.

Key improvements:

  • Added "How Baudbot works" section with runtime/deployment models and ASCII diagram
  • Expanded directory listing to cover previously undocumented areas (pi/skills/, test/, hooks/, .github/, .env.schema, bootstrap files)
  • Replaced vague "guardrails" language with explicit hard constraints vs strong defaults
  • Created focused guidelines for bin/, pi/extensions/, and slack-bridge/ with security-critical file inventories
  • Removed ~160 lines of redundant or obvious content from root guide
  • All referenced files and directories verified to exist in codebase

Confidence Score: 5/5

  • This documentation-only PR is safe to merge with no risk
  • Documentation changes only with no code modifications. All referenced files and directories exist in the codebase. The restructuring improves organization and clarity while maintaining accuracy
  • No files require special attention

Important Files Changed

Filename Overview
AGENTS.md Refactored root AGENTS.md: added architecture overview with data flow diagram, expanded directory listing, replaced vague guardrails with explicit constraints, removed redundancy, and improved organization by delegating directory-specific rules to nested AGENTS.md files
bin/AGENTS.md New directory-specific guidelines for bin/ covering CLI, deployment, security scripts, critical files inventory, and validation commands with proper security emphasis
pi/extensions/AGENTS.md New guidelines for pi/extensions/ with focus areas, rules for deterministic behavior, subdirectory extensions listing (kernel/, agentmail/, email-monitor/), and security-critical file identification
slack-bridge/AGENTS.md New guidelines for slack-bridge/ covering message handling, broker pull-mode, auth/rate-limit controls, key files inventory including crypto.mjs/crypto.test.mjs, and validation commands

Last reviewed commit: 4cb83c6

@benvinegar benvinegar merged commit 55acd30 into main Feb 22, 2026
9 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