Skip to content

Commit b5b3bec

Browse files
committed
re-work toc, don't like it off main page
1 parent 800c0c2 commit b5b3bec

File tree

3 files changed

+33
-33
lines changed

3 files changed

+33
-33
lines changed

docs/hub/_toctree.yml

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -454,36 +454,3 @@
454454
title: Hub API Endpoints
455455
- local: oauth
456456
title: Sign-In with HF
457-
458-
- local: xet/index
459-
title: Xet Protocol Specification
460-
isExpanded: false
461-
sections:
462-
- title: Building a client library for xet storage
463-
isExpanded: true
464-
sections:
465-
- local: xet/download-protocol
466-
title: Download Protocol
467-
- local: xet/upload-protocol
468-
title: Upload Protocol
469-
- local: xet/api
470-
title: CAS API
471-
- local: xet/auth
472-
title: Authentication and Authorization
473-
- local: xet/file-id
474-
title: Hugging Face Hub Files Conversion to Xet File ID's
475-
- title: Overall Xet architecture
476-
isExpanded: true
477-
sections:
478-
- local: xet/chunking
479-
title: Content-Defined Chunking
480-
- local: xet/hashing
481-
title: Hashing Methods
482-
- local: xet/file-reconstruction
483-
title: File Reconstruction
484-
- local: xet/xorb
485-
title: Xorb Format
486-
- local: xet/shard
487-
title: Shard Format
488-
- local: xet/deduplication
489-
title: Deduplication

docs/hub/xet/_toctree.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
- local: index
2+
title: Xet Protocol Specification
3+
4+
- title: Building a client library for xet storage
5+
sections:
6+
- local: upload-protocol
7+
title: Upload Protocol
8+
- local: download-protocol
9+
title: Download Protocol
10+
- local: api
11+
title: CAS API
12+
- local: auth
13+
title: Authentication and Authorization
14+
- local: file-id
15+
title: Hugging Face Hub Files Conversion to Xet File ID's
16+
17+
- title: Overall Xet architecture
18+
sections:
19+
- local: chunking
20+
title: Content-Defined Chunking
21+
- local: hashing
22+
title: Hashing Methods
23+
- local: file-reconstruction
24+
title: File Reconstruction
25+
- local: xorb
26+
title: Xorb Format
27+
- local: shard
28+
title: Shard Format
29+
- local: deduplication
30+
title: Deduplication

docs/hub/xet/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Implementors can create their own clients, SDKs, and tools that speak the Xet pr
2727

2828
## Reference implementation
2929

30+
### xet-core: hf-xet + git-xet
31+
3032
The primary reference implementation of the protocol written in rust 🦀 lives in the [xet-core](https://github.com/huggingface/xet-core) repository under multiple crates:
3133

3234
- [cas_types](https://github.com/huggingface/xet-core/tree/main/cas_types) - Common re-usable types for interacting with CAS API's
@@ -37,6 +39,7 @@ The primary reference implementation of the protocol written in rust 🦀 lives
3739
- [merklehash](https://github.com/huggingface/xet-core/tree/main/merklehash) - Exports a `MerkleHash` type extensively used to represent hashes. Exports functions to compute the different hashes used to track chunks, xorbs and files.
3840
- [data](https://github.com/huggingface/xet-core/tree/main/data) - Comprehensive package exposing interfaces to upload and download contents
3941
- [hf_xet](https://github.com/huggingface/xet-core/tree/main/hf_xet) - Python bindings to use the Xet protocol for uploads and downloads with the Hugging Face Hub.
42+
- [git-xet](ttps://github.com/huggingface/xet-core/tree/main/git-xet) - git lfs custom transfer agent that uploads files using the xet protocol to the Hugging Face Hub.
4043

4144
### Huggingface.js
4245

0 commit comments

Comments
 (0)