Add documentation generator script #33
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add scripts/generate-docs.ts to automatically generate API reference documentation from JSDoc comments in source code. The script discovers all resources, parses TypeScript to extract Props/Attrs interfaces and their JSDoc comments, links capabilities and event sources to resources, and generates one markdown file per resource in alchemy-effect/docs/{cloud}/{service}/.
Generated 23 initial resource docs covering AWS (S3, Lambda, DynamoDB, SQS, EC2) and Cloudflare (KV, R2). Update AGENTS.md to document that code is the single source of truth for all API documentation. Add generate:docs npm script.
Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
- Replace ts.isJSDocText with "text" in c check (API doesn't exist) - Use Array.from(docs.entries()) for Map iteration compatibility Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Extract resourceInfo and capabilityInfo values to local constants before nested visit functions to help TypeScript understand they are defined after the early return check. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
commit: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
scripts/generate-docs.tsto automatically generate API reference docs from JSDoc commentsnpm run generate:docsscriptTest plan
bun run generate:docssuccessfullyalchemy-effect/docs/are well-formatted🤖 Generated with Claude Code