SimplixStorage icon indicating copy to clipboard operation
SimplixStorage copied to clipboard

Improve documentation

Open lokka30 opened this issue 4 years ago • 4 comments

The documentation seems to be quite outdated, and perhaps, lacking in some places. If you want me to scroll over it and let you know exactly what I think needs updating, please don't be afraid to ask.

I wish to highlight that adding a FAQ (Frequently Asked Questions) page might be very beneficial, covering the questions you are frequently asked - saving you time that would otherwise be spent answering such question ;)

This isn't anything important - just a suggestion from me to improve the resource. Additionally, I would contribute to the Wiki myself if - if I had the knowledge. I've only just got back into using SimplixStorage (last used it when it was named LightningStorage), so I'm quite reliant on the documentation as I learn how to use this resource.

List:

  • [ ] Frequently Asked Questions page
  • [ ] Real-world examples in the docs

Thanks. :)

lokka30 avatar Aug 25 '21 12:08 lokka30

Hey lokka30,

Thank you so much for your feedback. We will improve the wiki as this has been various requests over this.

Regards Leonhard

KotlinFactory avatar Aug 25 '21 22:08 KotlinFactory

So we're targeting to improve the redo wiki this weekend. It would be great if you could "scroll over it and let you know exactly " let me know what needs to update. This way we can improve as fast as possible. Since PunishControl exists we know how to properly write wikis. I will just need to apply this to LightningStorage/SimplixStorage

Regards, Leonhard

KotlinFactory avatar Aug 25 '21 23:08 KotlinFactory

I would be interested in making a pr for this. I will see if I can make time to do so

Nuckerr avatar Nov 19 '21 19:11 Nuckerr

Would be great if you could!

KotlinFactory avatar Nov 21 '21 09:11 KotlinFactory