Skip to content

docs: comprehensive JSDoc for public API#1

Merged
bdelanghe merged 1 commit into
mainfrom
docs/document-public-api
Jun 23, 2026
Merged

docs: comprehensive JSDoc for public API#1
bdelanghe merged 1 commit into
mainfrom
docs/document-public-api

Conversation

@bdelanghe

Copy link
Copy Markdown
Contributor

Summary

  • Add TSDoc to all exported types, functions, and interface members
  • Ensure full API discoverability via Deno doc and other tools
  • Document behavior, arguments, and field purposes
  • Fix private type references via re-export or opaque types
  • All 37 tests pass; build succeeds

Test plan

  • bun run build — TypeScript compiles cleanly
  • bun test — 37 tests pass
  • deno doc --lint — Documentation requirements met

Generated with Claude Code

Add concise TSDoc to all exported types, functions, and interface members
across the Slack read surface. Ensures full API discoverability via Deno doc
and other documentation generators. All interfaces now document their fields;
all functions document behavior and arguments. Fixes private type references by
re-exporting or using opaque types where appropriate.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@bdelanghe bdelanghe merged commit fcc466b into main Jun 23, 2026
1 check passed
@bdelanghe bdelanghe deleted the docs/document-public-api branch June 23, 2026 03:28
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