Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: additional API docs #100

Merged
merged 2 commits into from
Jun 21, 2024
Merged

docs: additional API docs #100

merged 2 commits into from
Jun 21, 2024

Conversation

erickzhao
Copy link
Member

  • Adds documentation for API options that currently aren't detailed in README.md.
  • Clarifies inline API docs
  • Adds TypeDoc website (not sure if this is needed since the package is so small, but I'm not discriminating between Forge deps!)

@erickzhao erickzhao requested a review from a team as a code owner June 12, 2024 21:14
georgexu99
georgexu99 approved these changes Jun 21, 2024
View reviewed changes
Copy link
Contributor

@georgexu99 georgexu99 left a comment

Choose a reason for hiding this comment

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

Great changes!

@erickzhao erickzhao merged commit a7d68c4 into main Jun 21, 2024
6 checks passed
@erickzhao erickzhao deleted the docs/additional-api-docs branch June 21, 2024 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@georgexu99 georgexu99 georgexu99 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@erickzhao @georgexu99