chore(Documentation): Update UG nav and fix errors/warnings

glen-anderson / msdk

Software Development Kit for Analog Device's MAX-series microcontrollers

Apache License 2.0

0 stars 0 forks source link

chore(Documentation): Update UG nav and fix errors/warnings #7

Closed jkernion-adi closed 3 days ago

jkernion-adi commented 2 weeks ago

Description

Added newly created topics to nav in mkdocs.yml. Corrected all linter and mkdocs warnings and errors related to the user guide.

Checklist Before Requesting Review

[x] PR Title follows correct guidelines.
[x] Description of changes and all other relevant information.
[ ] (Optional) Link any related GitHub issues using a keyword
[ ] (Optional) Provide info on any relevant functional testing/validation. For API changes or significant features, this is not optional.

jkernion-adi commented 1 week ago

Update: All build errors in/around non-UG have been fixed. Only "warning" remaining is the known issue around Contributing.md link to UG, which will break in one place or another since it's duplicated and relative; current decision is to hold and see how users are viewing the file. Did not add Cordo topics to nav; current decision is to hold on this too, poss discuss w/Jake.