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] Quick tour refactor #2008

Merged
merged 3 commits into from
Oct 2, 2023
Merged

[docs] Quick tour refactor #2008

merged 3 commits into from
Oct 2, 2023

Conversation

MKhalusova
Copy link
Contributor

What does this PR do?

This PR refactors the Quick tour to make navigating it easier. It does so via rewriting some sections for simpler readability, restructuring the doc, and updating the headers. It also moves the "Internal mechanism" section into a separate conceptual guide.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Sep 26, 2023

The documentation is not available anymore as the PR was closed or merged.

Copy link
Collaborator

@muellerzr muellerzr 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 this huge rewrite!

I left some first-pass comments. One thing that'd be nice is try to see why we can't have these show on the sidebar. It may have something to do with nesting, I'll take a look today :)

docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
docs/source/quicktour.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@muellerzr muellerzr left a comment

Choose a reason for hiding this comment

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

Thanks! This looks fantastic!

Just left a few more suggestions for clarity but this is much easier for users to navigate!

docs/source/concept_guides/internal_mechanism.md Outdated Show resolved Hide resolved
docs/source/concept_guides/internal_mechanism.md Outdated Show resolved Hide resolved
docs/source/concept_guides/internal_mechanism.md Outdated Show resolved Hide resolved
docs/source/concept_guides/internal_mechanism.md Outdated Show resolved Hide resolved
@muellerzr muellerzr requested a review from LysandreJik October 2, 2023 14:56
Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

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

Much needed change, thanks @MKhalusova :)

@muellerzr muellerzr merged commit da98d60 into huggingface:main Oct 2, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants