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] update README with more specific docs for different use-cases #68

Open
bradtaniguchi opened this issue Nov 21, 2023 · 0 comments
Open

[docs] update README with more specific docs for different use-cases #68

bradtaniguchi opened this issue Nov 21, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation v2 any feature that will be part of v2

Comments

@bradtaniguchi
Copy link
Owner

Is this request related to a problem? Please describe.

The current docs aren't as clear cut on usage, even with typedocs being generated.

What could be updated to fix the problem(s)?

The docs should provide more examples and guides. Also possible look into having typedocs load more markdown file contents maybe?
@bradtaniguchi bradtaniguchi added documentation Improvements or additions to documentation v2 any feature that will be part of v2 labels Nov 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation v2 any feature that will be part of v2
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bradtaniguchi