docs: update README and documentation guide#158
Merged
carolstran merged 2 commits intomainfrom Feb 21, 2023
Merged
Conversation
|
Kudos, SonarCloud Quality Gate passed! |
Th3Un1q3
approved these changes
Feb 21, 2023
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
2 participants
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.
Currently, our README only reflects half of the reality of the SDK docs.
We migrated many of the guides to the new emnify Product Documentation, but the API reference is still generated in this repository and deployed to GitHub pages.
This PR aims to provide more information about the API reference docs by:
I also tried to add more context that I would've wanted to know while contributing to the documentation. This can still be improved, but hopefully it's a decent start 🙌🏼