document

To generate structured code documentation for an Effect-TS module, you can analyze source files directly to extract the API surface, data flow, dependencies, and error handling patterns. This process outputs comprehensive Markdown documentation for specific files, services, or directories.

The best way to document API surfaces and data flow is by reading source code directly to ensure accuracy. This approach extracts the public interface and external dependencies automatically, providing a structured overview of how data moves through the module.

Yes, you can analyze a single TypeScript file to extract its error handling patterns. The analysis reads the source file and its dependencies to understand its behavior, generating documentation that includes error handling and external dependencies.

Code documentation generation works for both an entire codebase and single services. You can target single files, specific service names, directories, or the full codebase to extract API surfaces and data flow into structured Markdown.

Manually documenting complex services becomes difficult because tracking data flow, dependencies, and error handling across modules requires continuous effort. Automating documentation by reading source code directly ensures accuracy and maintains a consistent Markdown structure.