documentation

To write a folder README, explain the directory's purpose and mental model, including diagrams and overviews of key exports. Focus on the "why" behind the project structure rather than just listing files.

Write JSDoc comments that document when and why to use code elements, including examples. Focus on public APIs and explaining the reasoning behind the code for clarity and maintainability.

The best way to document non-obvious code logic is using concise code comments. Explain the "why" behind complex decisions and workarounds rather than just describing what the code does.

You need to add documentation when others or your future self must easily understand the purpose and reasoning behind your work. Focus on explaining the mental model of directories and detailed public APIs.

Code comments should explain why the code was written, not what it does. Focus on clarifying non-obvious logic, complex decisions, and workarounds to ensure long-term maintainability.