Skip to content

[09/11] Rewrite and verify documentation#18

Merged
Albert-Gao merged 1 commit into
masterfrom
task/09-docs-rewrite
Jun 1, 2026
Merged

[09/11] Rewrite and verify documentation#18
Albert-Gao merged 1 commit into
masterfrom
task/09-docs-rewrite

Conversation

@Albert-Gao
Copy link
Copy Markdown
Owner

Summary

  • Rewrote the README around the current exported API and middleware behavior.
  • Clarified API Gateway v1/v2 support, shared state, response helpers, error defaults, logging, and trace info.
  • Removed stale badges and kept active package/repository badges.

Validation

  • npm run build
  • npm test -- --watch=false --no-watchman
  • Type-checked the README TypeScript examples against the built declarations.

@Albert-Gao Albert-Gao force-pushed the task/09-docs-rewrite branch from 2c11a04 to d216edc Compare June 1, 2026 13:36
@Albert-Gao Albert-Gao marked this pull request as ready for review June 1, 2026 13:36
@Albert-Gao Albert-Gao merged commit 959f5c0 into master Jun 1, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant