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

First full iteration of the docs migration to rtd #303

Merged
merged 7 commits into from
Sep 23, 2024
Merged

Conversation

ederjc
Copy link
Member

@ederjc ederjc commented Sep 20, 2024

First full iteration of the docs migration

  • Added boards overview table
  • Added legacy boards
  • Clean up file names
  • Readme: Add missing board, add badges, reformulate

Rendered version: https://xmc-arduino-staging.readthedocs.io/en/latest/index.html

Once this is reviewed and merged I will open a separate PR to the master branch for the docs migration.

Copy link
Collaborator

@LinjingZhang LinjingZhang left a comment

Choose a reason for hiding this comment

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

Very nice! Thanks Caro and Julian, no more headaches adding docu for XMC4Arduino.
lets merge then improve in iteration

Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we need to sync this part with README.md or just put a link to rtd in README.md?

and maybe off-topic, the system env path that was discussed before is documented here : https://github.com/Infineon/XMC-for-Arduino?tab=readme-ov-file#required-tools. We can also add note for JLinkGDBServer for windows users...

Copy link
Member Author

Choose a reason for hiding this comment

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

have a look at the changes in the README.

No more instructions there 😃

@ederjc ederjc merged commit 36351aa into docs/rtd Sep 23, 2024
2 checks passed
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.

2 participants