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

Migrate documentation from Wiki to Read The Docs #304

Merged
merged 31 commits into from
Sep 23, 2024
Merged

Conversation

ederjc
Copy link
Member

@ederjc ederjc commented Sep 23, 2024

Migrate documentation from Wiki to Read The Docs

Changes from previous PRs:

New changes:

  • Update CONTRIBUTING.md
  • Remove all Wiki content & replace links by RTD

Rendered preview:

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

PR Edits

  • Rebased to remove redundant commit messages.
  • Merged master into this branch to resolve merge conflicts

Copy link
Member

@jaenrig-ifx jaenrig-ifx left a 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.

CONTRIBUTING.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@@ -0,0 +1,313 @@
Deviations from Arduino Language Reference
==========================================
Copy link
Member

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.

Copy link
Member Author

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
Copy link
Member

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.

Copy link
Member Author

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

docs/hw-platforms.rst Show resolved Hide resolved
@@ -6,7 +6,7 @@
"websiteURL": "https://www.infineon.com",
Copy link
Member

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?

platform.txt Outdated Show resolved Hide resolved
tools/xmc-flasher.py Outdated Show resolved Hide resolved
@ederjc
Copy link
Member Author

ederjc commented Sep 23, 2024

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.

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.

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.

Thanks Julian and Caro! very nice Documentation 😺

I need to check a few things on my end:

  1. debug documentation and JLinkGDBSeverCL path
  2. Master branch -> latest release in PlatformIO XMC4Arduino
  3. 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.)

@ederjc ederjc merged commit a9c45b4 into master Sep 23, 2024
12 checks passed
@ederjc ederjc deleted the docs/rtd-staging branch September 23, 2024 16: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