-
Notifications
You must be signed in to change notification settings - Fork 368
Organize Hub Xet docs #1969
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
base: main
Are you sure you want to change the base?
Organize Hub Xet docs #1969
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR reorganizes the Xet storage documentation on the Hugging Face Hub by replacing the single "Storage Backends" page with a dedicated Xet section containing multiple focused subpages.
- Restructured storage documentation into a dedicated Xet section with individual pages for overview, usage, deduplication, legacy compatibility, and security
- Updated the Xet Protocol Specification to version 1.0.0 from the preliminary version
- Updated all internal links to point to the new Xet documentation structure
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
File | Description |
---|---|
docs/xet/index.md | Updated protocol version from 0.1.0 to 1.0.0 |
docs/hub/xet/*.md | Created dedicated pages for Xet overview, usage, deduplication, legacy compatibility, and security |
docs/hub/storage-backends.md | Removed the original storage backends page |
docs/hub/repositories.md | Updated link to point to new Xet index page |
docs/hub/index.md | Updated statistics and links to new Xet documentation structure |
docs/hub/_toctree.yml | Added hierarchical structure for Xet documentation pages |
docs/hub/_redirects.yml | Updated redirect for xet path to new location |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add redirect for old storage-backends links Co-authored-by: Julien Chaumond <[email protected]>
- local: xet/deduplication | ||
title: Deduplication | ||
- local: xet/legacy-git-lfs | ||
title: Backwards Compatibility & Legacy | ||
- local: xet/security | ||
title: Security |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- local: xet/deduplication | |
title: Deduplication | |
- local: xet/legacy-git-lfs | |
title: Backwards Compatibility & Legacy | |
- local: xet/security | |
title: Security | |
- local: xet/security | |
title: Security | |
- local: xet/legacy-git-lfs | |
title: Backwards Compatibility & Legacy | |
- local: xet/deduplication | |
title: Deduplication |
suggestion for ordering - so that the important stuff comes first.
(...same changes as #1956 just put in new PR since messed up rebase...)