Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README with the new template and add links to docs DS-281 #57

Merged
merged 1 commit into from
Oct 14, 2022

Conversation

MaferMazu
Copy link
Contributor

@MaferMazu MaferMazu commented Oct 13, 2022

Description

This PR updates the README documentation following this template and adds the correct links in the documentation.

How to test

To test the README, see https://github.com/eduNEXT/tvm/tree/mfmz/update-readme-and-doc
To test the links, go to https://edunext-docs-tvm--57.com.readthedocs.build/en/57/ and try links in the Related part of Topic Guides (Tutor Manager and Env manager); and check the Next Step of Quickstart and Tutorials>Creating Two Tutor Env

@MaferMazu
Copy link
Contributor Author

@wlvasquez If you have any chance, I would appreciate your review here 😊🙌

@MaferMazu MaferMazu linked an issue Oct 13, 2022 that may be closed by this pull request
@wlvasquez
Copy link

Hi Mafer:
I checked the links - good.
and reviewed the layout - Looks great!

dcoa
dcoa previously approved these changes Oct 14, 2022
Copy link
Contributor

@dcoa dcoa left a comment

Choose a reason for hiding this comment

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

I approved I only have a small recommendation (I'm not sure this could be possible), I think is better if the internal documentation links doesn't open a new tab (external links are okay)

@wlvasquez
Copy link

wlvasquez commented Oct 14, 2022 via email

@MaferMazu
Copy link
Contributor Author

Thank @dcoa and @wlvasquez for the advice; I agree. The PR is ready for your review again 😊

@wlvasquez
Copy link

Perfect. Reviewed and approved. Thank you Mafer

Copy link
Member

@JuanDavidBuitrago JuanDavidBuitrago left a comment

Choose a reason for hiding this comment

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

Thanks @MaferMazu, I agree with this changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] docs: user guide files has incorrect paths
4 participants