Skip to content

Commit 6f82c56

Browse files
committed
Add xet protocol subsection pages, finish toctree
1 parent 52e5f1d commit 6f82c56

File tree

3 files changed

+35
-2
lines changed

3 files changed

+35
-2
lines changed

docs/hub/_toctree.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@
5959
- local: xet/protocol/index
6060
title: Open Source Xet Protocol
6161
sections:
62-
- title: Building a client library for xet storage
62+
- local: xet/protocol/building-client
63+
title: Building a client library for xet storage
6364
sections:
6465
- local: xet/protocol/upload-protocol
6566
title: Upload Protocol
@@ -71,7 +72,8 @@
7172
title: Authentication and Authorization
7273
- local: xet/protocol/file-id
7374
title: Hub files conversion to Xet File ID's
74-
- title: Overall Xet architecture
75+
- local: xet/protocol/architecture
76+
title: Overall Xet architecture
7577
sections:
7678
- local: xet/protocol/chunking
7779
title: Content-Defined Chunking
@@ -85,6 +87,10 @@
8587
title: Shard Format
8688
- local: xet/protocol/deduplication
8789
title: Deduplication
90+
- local: xet/legacy-git-lfs
91+
title: Backwards Compatibility & Legacy
92+
- local: xet/security
93+
title: Security
8894

8995
- local: repositories-pull-requests-discussions
9096
title: Pull Requests & Discussions
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Overall Xet Architecture
2+
3+
(TODO: Add diagram here)
4+
5+
These pages will describe the overall Xet architecture, including how to perform chunking & hashing of files for upload, how to process file reconstruction information when downloading, the specfics of the Xorb and Shard formats, and how deduplication is achieved by a client library.
6+
7+
## Contents
8+
9+
- [Content-Defined Chunking](./xet/protocol/chunking)
10+
- [Hashing Methods](./xet/protocol/hashing)
11+
- [File Reconstruction](./xet/protocol/file-reconstruction)
12+
- [Xorb Format](./xet/protocol/xorb)
13+
- [Shard Format](./xet/protocol/shard)
14+
- [Deduplication](./xet/protocol/deduplication)
15+
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Building a client library for Xet storage
2+
3+
These pages explain how you can build a client library for Xet storage. Included in these pages are the steps involved in uploading & downloading files, the web service APIs involved, and how authentication and authorization works.
4+
5+
## Contents
6+
7+
- [Upload Protocol](./xet/protocol/upload-protocol)
8+
- [Download Protocol](./xet/protocol/download-protocol)
9+
- [CAS API](./xet/protocol/api)
10+
- [Authentication and Authorization](./xet/protocol/auth)
11+
- [Hub file conversion to Xet File ID](./xet/protocol/file-id)
12+

0 commit comments

Comments
 (0)