Documentation improvements, rewrite application development guides in Markdown#28
Merged
Conversation
szeka9
commented
Jun 28, 2026
szeka9
commented
Owner
- generate development guide deployed to the device with Markdown to HTML conversion
- move all documentation into docs/
- improve development guide
Improve the wording and fix inconsistencies. Add a new flowchart about connection lifecycle.
Use Markdown format for the application development guide, and move every documentation from the assets directory into the docs directory. Add a conversion script that generates HTML-formatted documents, deployed to the device as part of the MIP package.
Refer to example applications as "app" instead of "example" as it is easier to understand and remember.
Pin requirements for virtual environments for reproducibility.
Validate that output paths are relative to the current working directory, not equal to the root directory.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.