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

Update landing page #854

Merged
merged 5 commits into from Apr 29, 2022
Merged

Conversation

stevhliu
Copy link
Member

This PR updates index.md to focus only on the huggingface_hub library and removes mentions of the widgets and community API inference. This page provides:

  • A brief overview of what the Hub is and how the huggingface_hub is related to the Hub and what it can do. I think there may be some potential for confusion from users over the naming of the Hub (as a product) and huggingface_hub (as a library), so please let me know if I've made this distinction clear enough here!
  • A lot of guardrails that will help users down the right path and find what they are looking for. This ensures a user can choose their topic and then find a resource to help them accomplish their task. Once we've merged the other PRs, I can add the links in :)

I didn't mention integrating third-party libraries yet since we don't really have anything concrete yet. We can update the landing page once we have something (next on my to-do list!).

@stevhliu stevhliu added the documentation Improvements or additions to documentation label Apr 25, 2022
@stevhliu stevhliu mentioned this pull request Apr 25, 2022
5 tasks
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Apr 25, 2022

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

Copy link
Contributor

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

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

If this is the first page users see, it should include a link to the quick start guide, how to contribute, and code of conduct. (we should write the ones we don't have, not in this PR though). But a link to the github repo is an easy fix.

docs/source/index.mdx Outdated Show resolved Hide resolved
Copy link
Member

@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.

Thanks for writing this!

docs/source/index.mdx Outdated Show resolved Hide resolved
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.

Thank you @stevhliu

Copy link
Contributor

@adrinjalali adrinjalali left a comment

Choose a reason for hiding this comment

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

Thanks @stevhliu .

adding or fixing existing issues in the code, you can also help improve the
documentation by making sure it is accurate and up-to-date, help answer questions on
issues, and request new features you think will improve the library. Take a look at the
[contribution
Copy link
Contributor

Choose a reason for hiding this comment

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

It'd be nice to have both this contributing guide and our CoC rendered in the docs page. Not in this PR, but something to consider as a future PR.

@adrinjalali adrinjalali merged commit 9a516f5 into huggingface:main Apr 29, 2022
@stevhliu stevhliu deleted the update-landing-page branch April 29, 2022 15:48
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.

None yet

5 participants