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

Lack of documentation #198

Open
Gamadril opened this issue Mar 23, 2020 · 3 comments
Open

Lack of documentation #198

Gamadril opened this issue Mar 23, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Gamadril
Copy link

I know moko-widgets is still experimental, but it would be nice to see at least basic documentation with the description of the available elements and configuration options. The mandatory size parameter is not always clear to apply. An overview would be nice. Also a description about constraints would be helpful.
As far as I can see from the examples, constraints must be at the end of the container element and reference the elements by variables. But what if I create several elements in a for loop and immediately add them to a container? Is there a way to define constraints directly on the element itself after creation?

@Alex009
Copy link
Member

Alex009 commented Mar 23, 2020

hi!
agree, now documentation is very bad. it because first half of dev versions constantly was with api changes. now we got much more stable api and with release 0.1.0 we add more informative docs
something like https://github.com/icerockdev/moko-widgets/wiki/Widget-Gallery
and also samples of usage

@Alex009 Alex009 added the documentation Improvements or additions to documentation label Mar 23, 2020
@Alex009 Alex009 self-assigned this Mar 23, 2020
@Gamadril
Copy link
Author

Gamadril commented Apr 1, 2020

What about generating docs from source code? I looked into some files and couldn't find a line of comment describing the API or internal functions.

@Alex009
Copy link
Member

Alex009 commented Apr 2, 2020

it's good suggestion. i will try use https://github.com/Kotlin/dokka, but last time when i try it output site was not usable (ux was bad)...maybe now it better

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