Documentation update and add spell checker #578
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
noursaidi
reviewed
Feb 3, 2023
README.md
Outdated
| @@ -6,8 +6,8 @@ The Universal Device Management Interface (UDMI) provides a high-level specifica | |||
| management and operation of physical IoT systems. This data is typically exchanged | |||
| with a cloud entity that can maintain a "digital twin" or "shadow device" in the cloud. | |||
|
|
|||
| * [Core UDMI documentation](http://faucetsdn.github.io/udmi/docs/) for tools and specifications | |||
| * [Message schema definition](https://github.com/faucetsdn/udmi/tree/master/schema) with ([_🧬Interactive Viewer_](http://faucetsdn.github.io/udmi/gencode/docs/)) | |||
There was a problem hiding this comment.
The interactive viewer link on the home page should be to http://faucetsdn.github.io/udmi/ otherwise it's unrendered HTML code. Or a big "Read Docs" button which links to http://faucetsdn.github.io/udmi.
There was a problem hiding this comment.
Ok -- took that out for now, but still not happy about it because it's mixing code (raw source) with rendings... but will tilt at that windmill separately.
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.
No description provided.