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

Create documentation for the project #123

Open
theperu opened this issue Dec 3, 2023 · 1 comment
Open

Create documentation for the project #123

theperu opened this issue Dec 3, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@theperu
Copy link
Collaborator

theperu commented Dec 3, 2023

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 theperu added the documentation Improvements or additions to documentation label Dec 3, 2023
@theperu theperu self-assigned this Dec 8, 2023
@theperu
Copy link
Collaborator Author

theperu commented Dec 18, 2023

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:

  • Coding styles: for all the rules or best practices of our project
  • DB Structure
  • Setup + How to contribute and open a PR (this is partially implemented but we might want to improve it, for example we should make sure that we are all using the same version of Flutter)
  • Roadmap/Mission: we could add a page with what this project is about and why we are working on it
  • Reusable widget list: so that everyone knows what's already there and doesn't have to write everything from scratch
  • Folder Structure
  • How to contribute to the Documentation

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/)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant