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

Reorganize and update docs #615

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

davidmallasen
Copy link
Member

@davidmallasen davidmallasen commented Dec 26, 2024

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 -> Details button of the docs/readthedocs.org:x-heep CI 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.

@davidmallasen davidmallasen added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 26, 2024
@davidmallasen davidmallasen self-assigned this Dec 26, 2024
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 help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant