From 4e20a033596bd1348b4085abef83294be31fb496 Mon Sep 17 00:00:00 2001 From: bendtherules Date: Mon, 23 Mar 2026 12:31:52 +0530 Subject: [PATCH] docs(AGENTS): rename JSDoc Comments heading to Documentation and add note to update README when implementation changes --- AGENTS.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/AGENTS.md b/AGENTS.md index 7ad192e..78a3cef 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -81,11 +81,12 @@ bun run typecheck && bun run lint - Group imports: external packages, internal modules, types - Biome automatically organizes imports -### JSDoc Comments +### Documentation - Use JSDoc for all exported functions - Include `@example`, `@param`, and `@returns` descriptions - Add inline comments for hard-to-understand code +- Modify Readme.md, if implementation details have changed. ### Error Handling