AI Agent Documentation Optimizations

[jimwei1]

Description

Update AI agent docs, optimizing for concise, clear instructions with minimal unnecessary context pollution

---

Note

Refactors and consolidates AI agent documentation for clarity and brevity.

• Rewrites AGENTS.md with concise agent workflow, codebase conventions, component/style guidance, and references to new docs
• Adds docs/ai/api.md covering curried API usage and Effect-based schema enforcement patterns
• Adds docs/ai/state-management.md summarizing SWR/Zustand/Context patterns and cache invalidation approach
• Removes legacy docs/schema-enforcement-from-backend.md and docs/styling.md

^{Written by Cursor Bugbot for commit b374ccf. This will update automatically on new commits. Configure here.}

Greptile Summary

Consolidates verbose AI agent documentation into concise reference files, moving detailed architecture patterns from AGENTS.md into separate docs/ai/api.md and docs/ai/state-management.md files. Removes legacy docs/schema-enforcement-from-backend.md (406 lines) and docs/styling.md (8 lines) in favor of streamlined guidance integrated directly into AGENTS.md.

[augmentcode]

🤖 Augment PR Summary

Summary: Streamlines the AI agent documentation by replacing a large, detailed guidance doc with shorter, task-focused instructions and linking out to dedicated AI docs.

Changes:

• Rewrites AGENTS.md to emphasize phased delivery, asking for guidance when scope/complications arise, and core heuristics (KISS/YAGNI/DRY).
• Adds docs/ai/api.md documenting curried API helpers, query parameter construction, and Effect schema decoding/enforcement patterns.
• Adds docs/ai/state-management.md summarizing SWR/Zustand/Context responsibilities plus cache invalidation and provider-scoped store patterns.
• Deletes older long-form docs (docs/schema-enforcement-from-backend.md and docs/styling.md) in favor of the new concise references.

Technical Notes: The intent appears to be reducing “context pollution” while keeping key conventions discoverable via smaller, targeted docs.

_{🤖 Was this summary useful? React with 👍 or 👎}

[augmentcode]

Review completed. 2 suggestions posted.

Comment augment review to trigger a new review at any time.

[augmentcode]

AGENTS.md links to docs/ai/styling.md and docs/ai/api-layer.md, but in this PR the added files are docs/ai/api.md/docs/ai/state-management.md and the old docs/styling.md is removed; this will leave broken references for readers (also applies to the other items in this list).

_{🤖 Was this useful? React with 👍 or 👎}

[jimwei1]

thanks!

[greptile-apps]

_{5 files reviewed, 2 comments}

_{Edit Code Review Agent Settings | Greptile}