Reorganize and update docs #615
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
davidmallasen
added
documentation
|
@davideschiavone could you have a look? |
davideschiavone
requested changes
Jan 14, 2025
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.
This PR aims to restructure some of the docs to be more intuitive, especially for newcomers. It also improves the behavior of the left menu, so it's easier to expand and adapt to changes in the future. Furthermore, several parts have been updated.
You can see the updated docs in the
Show all checks->Detailsbutton of thedocs/readthedocs.org:x-heepCI check at the bottom of this PR. link.Please feel free to provide feedback on the documentation, particularly if you're new to the project. You can drop a comment in this PR or open an issue if this PR has already been merged.