Skip to content

Commit aff0a6c

Browse files
committed
Reorganize Storage Backend docs
1 parent 4f47567 commit aff0a6c

18 files changed

+5
-2393
lines changed

docs/hub/_toctree.yml

Lines changed: 2 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -47,46 +47,15 @@
4747
title: Repository Settings
4848
- local: storage-limits
4949
title: Storage Limits
50-
- local: storage-backends
51-
title: Storage Backend - Xet
50+
- local: xet/index
51+
title: Storage Backend (Xet)
5252
sections:
5353
- local: xet/overview
5454
title: Xet History & Overview
5555
- local: xet/using-xet-storage
5656
title: Using Xet Storage
5757
- local: xet/deduplication
5858
title: Deduplication
59-
- local: xet/protocol/index
60-
title: Open Source Xet Protocol
61-
sections:
62-
- local: xet/protocol/building-client
63-
title: Building a client library for xet storage
64-
sections:
65-
- local: xet/protocol/upload-protocol
66-
title: Upload Protocol
67-
- local: xet/protocol/download-protocol
68-
title: Download Protocol
69-
- local: xet/protocol/api
70-
title: CAS API
71-
- local: xet/protocol/auth
72-
title: Authentication and Authorization
73-
- local: xet/protocol/file-id
74-
title: Hub files conversion to Xet File ID's
75-
- local: xet/protocol/architecture
76-
title: Overall Xet architecture
77-
sections:
78-
- local: xet/protocol/chunking
79-
title: Content-Defined Chunking
80-
- local: xet/protocol/hashing
81-
title: Hashing Methods
82-
- local: xet/protocol/file-reconstruction
83-
title: File Reconstruction
84-
- local: xet/protocol/xorb
85-
title: Xorb Format
86-
- local: xet/protocol/shard
87-
title: Shard Format
88-
- local: xet/protocol/deduplication
89-
title: Deduplication
9059
- local: xet/legacy-git-lfs
9160
title: Backwards Compatibility & Legacy
9261
- local: xet/security

docs/hub/repositories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In these pages, you will go over the basics of getting started with Git and Xet
1717
- [Getting Started with Repositories](./repositories-getting-started)
1818
- [Settings](./repositories-settings)
1919
- [Storage Limits](./storage-limits)
20-
- [Storage Backend - Xet](./storage-backends)
20+
- [Storage Backend (Xet)](/.xet)
2121
- [Pull Requests & Discussions](./repositories-pull-requests-discussions)
2222
- [Pull Requests advanced usage](./repositories-pull-requests-discussions#pull-requests-advanced-usage)
2323
- [Collections](./collections)

docs/hub/storage-backends.md renamed to docs/hub/xet/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Xet Storage
1+
# Xet: our Storage Backend
22

33
Repositories on the Hugging Face Hub are different from those on software development platforms. They contain files that are:
44

@@ -13,14 +13,13 @@ Instead, on the Hub, these large files are tracked using "pointer files" and ide
1313

1414
Historically, Hub repositories have relied on [Git LFS](https://git-lfs.com/) for this mechanism. While Git LFS remains supported (see [Backwards Compatibility & Legacy](./xet/legacy-git-lfs)), the Hub has adopted Xet, a modern custom storage system built specifically for AI/ML development. It enables chunk-level deduplication, smaller uploads, and faster downloads than Git LFS.
1515

16-
In these pages you will get started in using Xet Storage, including the open-source Xet protocol.
16+
In these pages you will get started in using Xet Storage.
1717

1818
## Contents
1919

2020
- [Xet History & Overview](./xet/overview)
2121
- [Using Xet Storage](./xet/using-xet-storage)
2222
- [Deduplication](./xet/deduplication)
23-
- [Open Source Xet Protocol](./xet/protocol/index)
2423
- [Backwards Compatibility & Legacy](./xet/legacy-git-lfs)
2524
- [Security](./xet/security)
2625

docs/hub/xet/protocol/_toctree.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/hub/xet/protocol/api.md

Lines changed: 0 additions & 193 deletions
This file was deleted.

docs/hub/xet/protocol/architecture.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)