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

Modifications to documentation #400

Merged
merged 12 commits into from
Mar 26, 2024
Merged

Conversation

JuanSapriza
Copy link
Contributor

@JuanSapriza JuanSapriza commented Oct 16, 2023

We have to review the state of the documentations. Some tasks

  • Look for inconsistencies
  • Organize the tutorials in folders
    - [ ] Add more peripherals
  • Modify the README.md to give a short introduction and redirect to Read the docs
  • Modify the X-HEEP logo so it is dark-mode compatible. eg:

x-heep

@JuanSapriza
Copy link
Contributor Author

JuanSapriza commented Nov 7, 2023

@davideschiavone @JoseCalero Maybe you guys wanna take a look over the inconsistencies (you can see them if you cd docs & make clean html.

Note that the documentation is pointing at this branch now.

@davideschiavone
Copy link
Collaborator

there are missing pip dependencies in the conda environment that you may want to add as:

pip install sphinx
pip install myst-parser
pip install sphinx_rtd_theme

some images are missing (or their link is broken), e.g. x-heep/docs/build/html/How_to/ides/img/debug_screenshot.png

@davideschiavone davideschiavone self-requested a review November 7, 2023 17:21
@davidmallasen davidmallasen mentioned this pull request Nov 24, 2023
@JuanSapriza JuanSapriza mentioned this pull request Mar 26, 2024
@JuanSapriza JuanSapriza marked this pull request as ready for review March 26, 2024 17:37
@JuanSapriza
Copy link
Contributor Author

@JoseCalero Merge SVP

Copy link
Collaborator

@JoseCalero JoseCalero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@JoseCalero JoseCalero merged commit a49c47a into esl-epfl:main Mar 26, 2024
4 checks passed
@JuanSapriza JuanSapriza deleted the pr_docs branch May 16, 2024 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants