Docs/rtd staging #300
Docs/rtd staging #300
Conversation
…ons and Supported Boards included
New created RTD Docs
There was a problem hiding this comment.
Thanks to @CaGriesser , we finally have RTD for documentation, very good starting point 😻
docs/installation-instructions.rst
Outdated
| .. image:: img/J-Link_Installer_options_page.png | ||
| :width: 650 | ||
|
|
||
| Required tools |
There was a problem hiding this comment.
Sorry I updated the content here, it needs to be added: https://github.com/Infineon/XMC-for-Arduino?tab=readme-ov-file#required-tools
pip's link was displayed incorrectly
docs/hw-platforms.rst
Outdated
| Pinout Diagram | ||
| ^^^^^^^^^^^^^^ | ||
|
|
||
| .. image:: img/XMC_4700_RelaxKit_5VShields.png |
There was a problem hiding this comment.
Wrong pinout for XMC14 2go?
docs/hw-platforms.rst
Outdated
|
|
||
|
|
||
| KIT_XMC11_BOOT_001 | ||
| ------------------- |
There was a problem hiding this comment.
The naming is a bit weird for me.
The product name doesn't match the name inside the pinout diagram/IDE (code)
There was a problem hiding this comment.
Yep, the SCREAMING_SNAKE_CASE for the product ordering number also does not feel the best for me.
I would add not the product page title. The second one ?
|
As mentioned in the other PR, i think this info is redundant, and available in the product page. https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc1400_arduino/ |
|
We will iterate over this, but very nice to see how the docs are moving to RTD! 📜 |
Preview now available at: https://xmc-arduino-staging.readthedocs.io
Changes from Caro
Description
First version of the new created ReadTheDocs Documentation. Also a new Readme file.
Context
Ready for Review are allready: