Enhance documentation for contributing and previewing locally #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.