KAHelpers icon indicating copy to clipboard operation
KAHelpers copied to clipboard

Add examples, docs to the README

Open kaushalyap opened this issue 5 years ago • 6 comments

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

kaushalyap avatar Aug 17 '20 12:08 kaushalyap

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 avatar Aug 18 '20 07:08 FunkyMuse

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

timusus avatar Jun 23 '21 04:06 timusus

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

FunkyMuse avatar Jun 26 '21 11:06 FunkyMuse

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

rogergcc avatar Jul 28 '21 02:07 rogergcc

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

carstenhag avatar Aug 11 '21 21:08 carstenhag

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

FunkyMuse avatar Aug 11 '21 22:08 FunkyMuse

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: https://github.com/Kotlin/dokka/issues/2612.

5peak2me avatar Jul 19 '23 03:07 5peak2me