RIP-Comm / sossoldi

"Sossoldi" is a wealth management / personal finance / Net Worth tracking app, made with Flutter.
MIT License
270 stars 74 forks source link

Create documentation for the project #123

Open theperu opened 10 months ago

theperu commented 10 months ago

Given that more people are coming to the project we should start writing a bit more documentation and putting it all in one place. I was think that maybe we could try to use GitHub Pages to write all the documentation and gather the useful link so that then I could ask Mr. RIP to crate a short link that could be easy to remember.

theperu commented 9 months ago

UPDATE: since yesterday https://rip-comm.github.io/sossoldi/ is working and we can use it as a landing page for our project 🎉 Moving forward there are certainly lots of things that we can improve, as discussed on Discord here are a few task pages that would be really useful:

As always if anyone would like to work on some of them you can comment here and then open a PR when you are ready. If you don't know how GitHub Pages work don't worry it's pretty simple, you can just use .md files and link them as you would do normally, once those changes are merged in the main branch then the page will update automatically in a few seconds. To test the page inside your fork you need to activate them inside your fork (here is a guide) and then you will have your personalised link (ex. https://theperu.github.io/sossoldi/)