-
Notifications
You must be signed in to change notification settings - Fork 69
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
Migrate documentation from Wiki to Read The Docs #304
Conversation
…ons and Supported Boards included
- fix erase parameter
510410e
to
7f37c88
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to finally get this moved to RTD 👍
A few small topics.
Only the platform.txt and tools/xmc-flasher.py script. Be sure that is well synched, and not overwriting a latest version of these files. No need to make a separate PR for me (even that would be the ideal), but be sure the changes are relevant.
@@ -0,0 +1,313 @@ | |||
Deviations from Arduino Language Reference | |||
========================================== |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Section to be reviewed once ArduinoCore-API integration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Section has been taken from Wiki and will be adapted incrementally
@@ -0,0 +1,272 @@ | |||
Built-in Libraries |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, but harder to maintain that a board vs library supported. I would assume if a library is supported by a board, some (if not all) examples will be supported.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Section has been taken from Wiki and will be adapted incrementally
@@ -6,7 +6,7 @@ | |||
"websiteURL": "https://www.infineon.com", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall this point to the repository instead of the infineon website?
There were actually no changes on these files, but the rebase somehow brought them up. I merged the master into this branch and now it should be fine. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Julian and Caro! very nice Documentation 😺
I need to check a few things on my end:
- debug documentation and JLinkGDBSeverCL path
- Master branch -> latest release in PlatformIO XMC4Arduino
- Update Contributing.md (or maybe confluence?) for IFX development (some more details for working student, e.g. using make/clang tools in WSL because of unity, clang, cppcheck.)
Migrate documentation from Wiki to Read The Docs
Changes from previous PRs:
New changes:
Rendered preview:
https://xmc-arduino-staging.readthedocs.io/en/latest/index.html
PR Edits