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 Revamp: new "Main" page for hub-docs #88

Merged
merged 6 commits into from
Apr 6, 2022

Conversation

NimaBoscarino
Copy link
Contributor

@NimaBoscarino NimaBoscarino commented Apr 4, 2022

As part of the hub-docs revamp (#62 , https://www.notion.so/huggingface2/Hub-Documentation-Revamp-ec395476acf846879f57ee033fcee963) we're restructuring the documentation to follow the structure of the Hub offerings (Datasets, Models, Spaces, etc.) with an emphasis on granularity.

This PR contains a first version of the "main" landing page for the Hub documentation, acting as an entry point and explaining the various features of the Hub at a high level. I've added the page to _sections.yml just at the top for now, but will adjust the page listings in a future PR.

Note that any bolded items in the page will be linking to relevant documentation (currently not existing, but coming in future PRs!). All future PRs for this will also merge into docs-revamp, until a complete release is ready for main.

WIP: More content and structure needed
Original main page not removed
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.

Great first draft! :)

For the Models section, it'd be nice to also mention Model Cards and how important they are for promoting responsible usage, limitations, and biases. I think this is especially important since one of our values is democratizing good ML.

docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
NimaBoscarino and others added 3 commits April 4, 2022 17:46
Mostly grammar and and phrasing adjustments.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@NimaBoscarino
Copy link
Contributor Author

also mention Model Cards and how important they are

@stevhliu Great point! I changed it up to include Model Cards, let me know what you think!

@stevhliu
Copy link
Member

stevhliu commented Apr 5, 2022

Thanks for mentioning the Model Cards, looks good!

Copy link
Contributor

@osanseviero osanseviero left a comment

Choose a reason for hiding this comment

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

This is super exciting! I left a couple of ideas but overall this looks amazing! Nice work 🚀

docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
docs/hub/hugging-face-hub.md Outdated Show resolved Hide resolved
Fix incorrect info and rephrase for clarity.
Copy link
Contributor

@osanseviero osanseviero left a comment

Choose a reason for hiding this comment

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

This is great, thanks for this PR!

@osanseviero
Copy link
Contributor

Btw remember to mark conversations as resolved if you don't expect the reviewer to take a second look to it, if not it's hard to know what was addressed.

@NimaBoscarino NimaBoscarino merged commit 52ce39a into docs-revamp Apr 6, 2022
@NimaBoscarino NimaBoscarino deleted the revamp/hub-main branch April 6, 2022 15:24
NimaBoscarino added a commit that referenced this pull request Apr 6, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@julien-c
Copy link
Member

julien-c commented Apr 6, 2022

Just reading this now, but it's really cool!

NimaBoscarino added a commit that referenced this pull request Apr 18, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
osanseviero pushed a commit that referenced this pull request Apr 22, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
osanseviero pushed a commit that referenced this pull request Apr 22, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
NimaBoscarino added a commit that referenced this pull request May 11, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
NimaBoscarino added a commit that referenced this pull request May 11, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
NimaBoscarino added a commit that referenced this pull request May 15, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
NimaBoscarino added a commit that referenced this pull request May 15, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
NimaBoscarino added a commit that referenced this pull request May 20, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
NimaBoscarino added a commit that referenced this pull request May 20, 2022
Create Hugging Face Hub main doc page, with bolded items intended as future links to docs.

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
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