Skip to content

Add api docs#28

Merged
pleek91 merged 2 commits intomainfrom
api-docs
Feb 17, 2025
Merged

Add api docs#28
pleek91 merged 2 commits intomainfrom
api-docs

Conversation

@pleek91
Copy link
Copy Markdown
Collaborator

@pleek91 pleek91 commented Feb 17, 2025

Description

Adds generated api docs following what we've done in @kitbag/router

@pleek91 pleek91 added the documentation Improvements or additions to documentation label Feb 17, 2025
Copy link
Copy Markdown
Contributor

@stackoverfloweth stackoverfloweth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is fine, though I think given the size and scope of this project I personally would vote we manually curate the API docs moving forward. All the types are fine as is but it's less great having just the 1 big page for createEmitter. I found that page to be pretty long and not super well structured the way it's auto-generated.

Base automatically changed from repo-cleanup to main February 17, 2025 18:15
@pleek91 pleek91 merged commit df09eb3 into main Feb 17, 2025
2 checks passed
@pleek91 pleek91 deleted the api-docs branch February 17, 2025 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants