Add documentation and release info to README#447
Merged
jstjohn merged 3 commits intoNov 18, 2024
Merged
Conversation
Signed-off-by: Hassan Sirelkhatim <sirelkhatim_hamid1990@hotmail.com>
jstjohn
reviewed
Nov 18, 2024
jstjohn
requested changes
Nov 18, 2024
Collaborator
jstjohn
left a comment
There was a problem hiding this comment.
Once you remove the reversions back to an older version of the readme, the rest looks good. Thanks!
jstjohn
approved these changes
Nov 18, 2024
Collaborator
|
/build-ci |
Signed-off-by: Tyler Shimko <tshimko@nvidia.com>
tshimko-nv
approved these changes
Nov 18, 2024
Collaborator
tshimko-nv
left a comment
There was a problem hiding this comment.
I updated the spacing and header level to improve rendering in GFM, otherwise, looks good to me.
Collaborator
|
/build-ci |
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
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.
Summary
Modified README to include documentation and release info
Details
Added details on how to download the container and where to find documentation, user guides, API references and trouble shooting information
Usage
Not Applicable as this is just a modification to the README
Testing
Not Applicable as this is just a modification to the README