New documentation site + missing pages #145
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mene412
reviewed
Feb 4, 2024
mene412
reviewed
Feb 4, 2024
mene412
reviewed
Feb 4, 2024
mene412
reviewed
Feb 4, 2024
docs/contributing/PR-guide.md
Outdated
| layout: default | ||
| nav_order: 3 | ||
| has_children: true | ||
| --- | ||
| # GitHub for beginners | ||
|
|
||
| So you want to partecipate in our project but you don't know how? Don't worry, this guide is here for you. | ||
| In the next steps we will assume that you already completed the environment setup. If you haven't, make sure to follow *the first 3 steps* of [this guide](setup.md) first. |
There was a problem hiding this comment.
Suggested change
| In the next steps we will assume that you already completed the environment setup. If you haven't, make sure to follow *the first 3 steps* of [this guide](setup.md) first. | |
| In the next steps we will assume that you already completed the environment setup. If you haven't, make sure to follow *the first 3 steps* of [this guide](setup.html) first. |
mene412
reviewed
Feb 4, 2024
docs/setup/setup-linux-evironment.md
Outdated
There was a problem hiding this comment.
Wrong source link at line 233 for Screenshot_Intellij_cmdline-tools.png
mikev-cw
reviewed
Feb 5, 2024
docs/roadmap.md
Outdated
|
|
||
| ### 3. Google Sheets Integration | ||
|
|
||
| - Integrate with Google Sheets to provide users with a more in-depht environment for financial planning. |
There was a problem hiding this comment.
There's a typo in "depth"
|
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 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 😁