Skip to content

Conversation

rajatarya
Copy link
Contributor

Attempt to reorganize Xet content so:

  • Storage Backends -> Storage Backend - Xet
  • Xet Protocol sections are subsections of Xet documentation
  • Set up docs for more visuals added to sections, make Xet more top-level visible in Hub docs.

@HuggingFaceDocBuilderDev

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.

@rajatarya
Copy link
Contributor Author

image

The TOC doesn't seem to render well when it is 3 levels deep with longer subsection headers.

But this I believe is organized how Hub docs work - there are many small pages instead of larger ones - so I reorganized the main Storage Backends page into sections, and a TOC in the main page. The TOC can have deep links and then the navigation at the footer correctly goes to the next page in the section of docs.

@jsulz
Copy link
Contributor

jsulz commented Sep 26, 2025

I agree that the navigation is far improved, but the lack of margin-left on the final level in the TOC tree is kind of distracting.

What if we just removed the Open Source Xet Protocol and moved Building a client library for Xet storage and Overall Xet architecture one level up?

Copy link
Member

@julien-c julien-c left a comment

Choose a reason for hiding this comment

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

Ok i'm going to contradict myself from what i said in #1952 but probably makes more sense to keep the protocol in its own doc (/docs/xet) – given there are quite a number of pages and probably more in the future if some community-driven third party tools or implementations arise – while renaming the current Hub "entry point" page from /docs/hub/storage-backends to /docs/hub/xet.

WDYT?

- [Settings](./repositories-settings)
- [Storage Limits](./storage-limits)
- [Storage Backends](./storage-backends)
- [Storage Backend - Xet](./storage-backends)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- [Storage Backend - Xet](./storage-backends)
- [Storage Backend (Xet)](./xet)

maybe we take this opportunity to just rename that entry point page to /docs/hub/xet

@@ -1,4 +1,4 @@
# Storage
# Xet Storage
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# Xet Storage
# Xet: our Storage Backend

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