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.

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

Better documentation #20

Open
3 tasks
arnemolland opened this issue Feb 15, 2023 · 2 comments
Open
3 tasks

Better documentation #20

arnemolland opened this issue Feb 15, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@arnemolland
Copy link
Owner

arnemolland commented Feb 15, 2023

Right now, there's limited documentation, no guides and no proper examples. At the very least, the library should;

  • Include good documentation for the entire public API surface
  • Include "getting started" guide as well as guides for common use-cases
  • Include example application(s)
@arnemolland arnemolland added the documentation Improvements or additions to documentation label Feb 15, 2023
@arnemolland arnemolland self-assigned this Feb 15, 2023
@neiljaywarner
Copy link

@arnemolland i'm interested in this but it's not clear what the purpose is to me, ie does it relate to design tokens, or what woudl be the purpose.
thanks

@arnemolland
Copy link
Owner Author

@arnemolland i'm interested in this but it's not clear what the purpose is to me, ie does it relate to design tokens, or what woudl be the purpose. thanks

Sorry for the late reply, my inbox has been hammered lately.

First of all, a good API reference. Then, some guides or use cases that might help getting started with the library. A demo application would be a bonus as well, as long as it's able to demonstrate what can be done.

I have some use cases myself from my own use, I just need to find time to get it done properly.

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

No branches or pull requests

2 participants