theperu
commented
5 months ago I fixed all the stuff that you pointed out, I'll go ahead and merge this so that we can see if we need to do something also for the deploy of the new page but hopefully everything will work as expected
As I was writing the missing pages for our documentation I realised that I simple page like the one that we used until now was really hard to navigate and it might be difficult to use for newcomers. I looked around and I think I have found a good template for our project called Just the Docs. By using it we would have a list of all the pages on the left and also a search bar at the top, in this PR there is also the workflow needed to update it which should work once we merge it and run automatically only when we make changes to the docs folder.
Apart from this, I also tried to write something for all the missing pages which are:
I didn't create one for the DB because we will make a few changes in the near future and I think it would make much more sense to do it once we have more stable structure.
If you want to checkout how the docs will look with these changes you can do it at https://theperu.github.io/sossoldi/
Let me know what you think about all of these especially the Roadmap and Coding Style pages since are quite important and we should all decide together 😁