Add User Guide #273
Add User Guide #273
Conversation
This reverts commit cdaef1e.
- Trying to get build-docs working as a reusable workflow is a pain. The ultimate solution was to upload the docs folder as an artifact to then re-download for the deploy step. This took 10+ minutes each way. - Only auto-trigger docs build/deploy on the release branch, and do it in the same job
@kevin-gillespie Hey man I heard you like docs so I wrote some docs on how to get to the docs that tell you how to write and build the docs: https://jake-carter.github.io/msdk/CONTRIBUTING/#contributing-documentation There's a Python script in the repo now that you can use to build the static site locally. Could probably update the action to use it but installing Doxygen is kind of a pain in the ass on the command-line |
|
What do you think about moving some of the files into the Documentation folder? It's nice to have the README in the root so we see it on the GitHub home page, but I think it would keep things better organized if we moved the rest to the Documentation folder. |
Agreed, see 251c7af |
@Analog-Devices-MSDK/msdk_developers @Analog-Devices-MSDK/msdk_contributors @Analog-Devices-MSDK/msdk_maintainers
This PR adds a universal User Guide for the MSDK. The README has also been updated to point to it as the primary source of documentation.
It can be previewed from my fork here: https://jake-carter.github.io/msdk/USERGUIDE/
The online copy is created with mkdocs and deployed with Github Pages via a new "Build Docs" action. The action also builds the Peripheral Driver Doxygen and packages it into the site under the Peripheral Driver API section.
The User Guide is maintained in a single Markdown file that can also be viewed directly: https://github.com/Jake-Carter/msdk/blob/dev/userguide/USERGUIDE.md