docs(Documentation): Update User Guide to Support June 2023 Release #683
Conversation
This file contains hidden or 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
This reverts commit ca6c8b7.
github-actions
bot
added
MAX32672
|
Examples section has been updated with "Common Examples" vs part-specific examples (preview) |
Jake-Carter
requested review from
Jacob-Scheiffler,
lorne-maxim and
sihyung-maxim
Examples/MAX32662/Demo/main.c
Outdated
| @@ -33,7 +33,7 @@ | |||
|
|
|||
| /** | |||
| * @file main.c | |||
| * @brief Demo | |||
| * @brief This example demonstrates the use of the TFT Display, UART Terminal, RTC, Pushbuttons, and LEDs on the MAX32662EVKIT. | |||
There was a problem hiding this comment.
MAX32662EVKIT gets added in the common examples.
|
Should we leave the ME55 in the common examples? These examples specifically are untested and must be updated when we start the bring-up. |
Jacob-Scheiffler
approved these changes
Aug 1, 2023
Thanks, blacklisted the MAX32572. 66c25f7 |
sihyung-maxim
approved these changes
Aug 4, 2023
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.
Pull Request Template
Description
This PR updates the MSDK User Guide. A preview of the new version can be viewed here: https://jake-carter.github.io/msdk/USERGUIDE/
Major changes:
Add support for the details PyMarkdown extension. The User Guide is now populated with helpful notes/warning dropdowns with improved formatting.
Add documentation for headless/command-line installations (preview)
General formatting improvements with the addition of custom CSS
Update Tables for Build Config Variables (preview)
Add documentation on VS Code Disassembly View (preview)
Add
setenv.shas an option for Command-Line setup instructions (preview)Document make targets for flashing (
make flash.openocd) (preview)Fix typo in BSP Search Directory code example (preview)
Add auto-generated tables of examples for all microcontrollers (preview)
Add MAX32662 web links now that part is released.
Add CoreMark library section (preview)
Add Debugger documentation (preview)
Checklist Before Requesting Review