Skip to content

Add documentation and release info to README#447

Merged
jstjohn merged 3 commits into
NVIDIA-BioNeMo:mainfrom
sirelkhatim:sirelkhatim/add-documentation-info-readme
Nov 18, 2024
Merged

Add documentation and release info to README#447
jstjohn merged 3 commits into
NVIDIA-BioNeMo:mainfrom
sirelkhatim:sirelkhatim/add-documentation-info-readme

Conversation

@sirelkhatim
Copy link
Copy Markdown
Contributor

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

Signed-off-by: Hassan Sirelkhatim <sirelkhatim_hamid1990@hotmail.com>
@jstjohn jstjohn added the documentation Improvements or additions to documentation label Nov 18, 2024
Comment thread README.md Outdated
Copy link
Copy Markdown
Collaborator

@jstjohn jstjohn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once you remove the reversions back to an older version of the readme, the rest looks good. Thanks!

Comment thread README.md Outdated
Comment thread README.md Outdated
@jstjohn
Copy link
Copy Markdown
Collaborator

jstjohn commented Nov 18, 2024

/build-ci

Signed-off-by: Tyler Shimko <tshimko@nvidia.com>
Copy link
Copy Markdown
Collaborator

@tshimko-nv tshimko-nv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the spacing and header level to improve rendering in GFM, otherwise, looks good to me.

@tshimko-nv
Copy link
Copy Markdown
Collaborator

/build-ci

@jstjohn jstjohn merged commit f4be30d into NVIDIA-BioNeMo:main Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants