update README and sync with the wiki #262
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LinjingZhang
force-pushed
the
master
branch
2 times, most recently
from
350fbcd
to
3744526
Compare
docs/_Sidebar.md
Outdated
| * [XMC4700 Relax Kit](XMC4700-Relax-Kit) | ||
| * Legacy board (Supported until 1.7.0) | ||
| * [XMC1100 H-Bridge 2Go](XMC1100-H-Bridge-2Go) | ||
| * [XMC1300 Boot Kit](XMC1300-Boot-Kit) |
There was a problem hiding this comment.
as mentioned in the other comment. The XMC1300 Boot Kit is not a legacy board but a supported board.
There was a problem hiding this comment.
I just change it
A question: https://github.com/Infineon/XMC-for-Arduino/wiki/XMC1300-Boot-Kit the link in this page has been deprecated. Any Update needed?
There was a problem hiding this comment.
Good point. I believe since the docs are to be migrated to RTD, they have to be redone anyway. So I think this is fine for now. @jaenrig-ifx can further comment.
boramonideep
suggested changes
Jan 29, 2024
fix link
boramonideep
approved these changes
Jan 30, 2024
jaenrig-ifx
approved these changes
Jan 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---
CONTRIBUTING.md also tells you what to expect in the PR process.
Description
Update README, CONTRIBUTING (docs in root) and wiki
clean the wiki structure, check CONTRIBUTING Wiki section for new PR flow for wiki update
Related Issue
No
Context
Check commits for Wiki in this repo:
https://github.com/LinjingZhang/XMC-for-Arduino/commits/wiki_master/
And preview of Wiki:
https://github.com/LinjingZhang/XMC-for-Arduino/wiki