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

[open call] Help to make API docs #167

Open
bushev opened this issue Apr 18, 2021 · 2 comments
Open

[open call] Help to make API docs #167

bushev opened this issue Apr 18, 2021 · 2 comments

Comments

@bushev
Copy link

bushev commented Apr 18, 2021

Hey @remy, thanks for the great console component!

Is there are any docs for the component API? How to use it in another React app? Is TypeScript supported?

Thank,
Yury

@criticalfault
Copy link

I was thinking the same thing. We could really use a filled out readme to see how this would be used in applications!

@remy
Copy link
Owner

remy commented May 21, 2021

There's not any docs. It's not officially supported (by me) so I've avoided documenting it intentionally. It works, because I've done it - and I know some others have done it too. I'd be happy to add any contributed docs to the project if it takes anyone's fancy.

@remy remy changed the title How I can find some docs? [open call] Help to make API docs May 21, 2021
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

No branches or pull requests

3 participants