Skip to content

Commit bc59dee

Browse files
committed
Add xet protocol subsection pages, finish toctree
1 parent 849b2a3 commit bc59dee

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed
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)