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

Updated Documentation for contributing and previewing #1391

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

swalehmwadime
Copy link

Overview

This pull request enhances the documentation for the Hugging Face Hub repository. It includes the following updates:

  • Contributing Instructions: Added a step-by-step guide on how to contribute to the documentation, including committing changes and creating a Pull Request (PR).
  • Related Components: Provided detailed links and descriptions for related components and utilities associated with Hugging Face Hub.
  • Local Preview Instructions: Improved instructions for previewing documentation changes locally, including installation commands and usage of doc-builder.

These changes aim to make it easier for contributors to understand how to interact with the documentation and ensure that updates are correctly previewed before submission.

Changes

  • Added and clarified sections on how to contribute to the documentation.
  • Updated links to related Hugging Face Hub components and utilities.
  • Enhanced the local preview instructions for better user experience.

Testing

No functional changes were made. This update is to improve documentation clarity and usability.

…-README

Enhance documentation for contributing and previewing locally
Insert Links to relevant sites
Improve Dask integration documentation for Hugging Face Hub

- Added prerequisites and authentication steps for using Hugging Face paths with Dask.
- Provided examples for writing and reading Dask DataFrames in Parquet format to/from the Hugging Face Hub.
- Enhanced clarity on how to create and manage dataset repositories using the HfApi class.
- Updated references to the Hugging Face File System documentation for further reading.
Dask Integration Documentation for Hugging Face Hub
Insert link to Hugging Face filesystem API
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.

1 participant