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

Improve documentation #48

Open
2 tasks
lokka30 opened this issue Aug 25, 2021 · 4 comments
Open
2 tasks

Improve documentation #48

lokka30 opened this issue Aug 25, 2021 · 4 comments
Labels
enhancement New feature or request

Comments

@lokka30
Copy link

lokka30 commented Aug 25, 2021

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. :)

@KotlinFactory
Copy link
Member

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
Copy link
Member

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 KotlinFactory added the enhancement New feature or request label Nov 5, 2021
@Nuckerr
Copy link
Contributor

Nuckerr commented Nov 19, 2021

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

@KotlinFactory
Copy link
Member

Would be great if you could!

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

No branches or pull requests

3 participants