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

Add examples, docs to the README #7

Closed
kaushalyap opened this issue Aug 17, 2020 · 7 comments
Closed

Add examples, docs to the README #7

kaushalyap opened this issue Aug 17, 2020 · 7 comments
Labels
Documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@kaushalyap
Copy link

kaushalyap commented Aug 17, 2020

There is no docs and no examples in the README, Please consider adding them

@FunkyMuse FunkyMuse added the enhancement New feature or request label Aug 18, 2020
@FunkyMuse
Copy link
Owner

FunkyMuse commented Aug 18, 2020

Many of the extensions are pretty straight forward and do not need examples to do so, I believe anyone with common knowledge can get a grasp of them.

However this is an open source project and there's too many of them and some of them require that, I understand but as i'm working on another things I would be needing help/contributions in adding the examples/wikis and/or READMEs, feel free to make a pull request regarding this.

@FunkyMuse FunkyMuse added help wanted Extra attention is needed Documentation labels Aug 22, 2020
@timusus
Copy link

timusus commented Jun 23, 2021

I'd recommend you re-open this issue if you'd like help with it.

@FunkyMuse FunkyMuse reopened this Jun 26, 2021
@FunkyMuse
Copy link
Owner

if someone can add dokka, i'd appreciate it, currently busy with other stuff

@rogergcc
Copy link

rogergcc commented Jul 28, 2021

need a helper(extension) for make readme doc and examples.

@carstenhag
Copy link

Agree, would be nice to have this. I have seen this repo a few times but had no clue whether it is actually helpful, as there are no examples

@FunkyMuse
Copy link
Owner

Agree, would be nice to have this. I have seen this repo a few times but had no clue whether it is actually helpful, as there are no examples

feel free to open a PR, it'll help a lot
dokka would be nice and easy integration

@5peak2me
Copy link
Contributor

It seems that Dokka does not support configuration cache, and in order to integrate Dokka, it needs to be disabled. For specific information, please refer to this link: Kotlin/dokka#2612.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

6 participants