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.

Sign up for GitHub

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

Jump to bottom

add docs #214

Merged
merged 4 commits into from
Mar 30, 2023
Merged

add docs #214

merged 4 commits into from
Mar 30, 2023

Conversation

pacman100
Copy link
Contributor

What does this PR do?

  1. Adding HF docs

stevhliu
stevhliu reviewed Mar 24, 2023
View reviewed changes
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Wow you're so fast, thanks for kicking this off! I think the main thing is the actual docs need to be in a source file, for example docs/source/index.mdx.

docs/_toctree.yml Outdated Show resolved Hide resolved
.github/workflows/build_documentation.yml Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/quicktour.mdx Outdated Show resolved Hide resolved
docs/quicktour.mdx Outdated Show resolved Hide resolved
docs/quicktour.mdx Outdated Show resolved Hide resolved
docs/quicktour.mdx Outdated Show resolved Hide resolved
docs/quicktour.mdx Outdated Show resolved Hide resolved
@pacman100 @stevhliu
Apply suggestions from code review
13476a8 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
MKhalusova
MKhalusova approved these changes Mar 27, 2023
View reviewed changes
Copy link
Contributor

@MKhalusova MKhalusova left a comment

Choose a reason for hiding this comment

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

Great start! I think that "quick tour" is a bit overwhelming, and maybe there's a way to split it further or focus on simple examples, and leave the details and caveats for other sections.

docs/index.mdx Outdated Show resolved Hide resolved
stevhliu
stevhliu approved these changes Mar 28, 2023
View reviewed changes
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Thanks for all the changes! Last thing is to just put all the docs under a docs/source folder 👍

@pacman100 pacman100 requested review from stevhliu and MKhalusova and removed request for stevhliu and MKhalusova March 29, 2023 11:44
stevhliu
stevhliu approved these changes Mar 29, 2023
View reviewed changes
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Nice, let's merge it! 🚀

@pacman100 pacman100 marked this pull request as ready for review March 30, 2023 05:17
@pacman100 pacman100 merged commit 542f247 into main Mar 30, 2023
@pacman100 pacman100 deleted the smangrul/add-docs branch May 3, 2023 19:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevhliu stevhliu stevhliu approved these changes

@MKhalusova MKhalusova MKhalusova approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pacman100 @MKhalusova @stevhliu