Skip to content

Commit 4acf48f

Browse files
committed
docs: add AsciiDoc outline for README
1 parent 3c9e06e commit 4acf48f

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

‎README.adoc‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
= 🫙 `git-store`
2+
:author: Joey Carpinelli
3+
:email: joseph.carpinelli@icloud.com
4+
:description: Typed documents stored as Git trees, thanks to `facet.rs` reflection in Rust.
5+
6+
== Motivation
7+
8+
// Storing documents which relate to code alongside code is desirable.
9+
10+
== History of Metadata in Git
11+
12+
// Discuss chronologically...
13+
//
14+
// . `git-notes`
15+
// . `git-metadata`
16+
// . `git-bug`
17+
// . `git-appraise`
18+
// . `git-branchless`
19+
// . `radicle`
20+
// . Gerrit
21+
//
22+
// Or, alternatively, categorize the above projects...
23+
//
24+
// . Fan-out Indices as Refs
25+
// . JSON-like storage in Blobs
26+
// . Project Maintenance via Remote Helpers
27+
28+
== Review of Data Storage
29+
30+
// Chapter of Designing Data Intensive Applications, including...
31+
//
32+
// . Storage
33+
// . Queries
34+
// . Wire Format
35+
//
36+
// Also, include a kind of chronology from the textbook.
37+
// When building a database solution, you want the following properties...
38+
//
39+
// . Schema Evolution
40+
// . Stable Wire Format
41+
// . Support for Multiple Programming Languages
42+
43+
== Typed Documents via Reflection
44+
45+
// Present the following pieces...
46+
//
47+
// . Reflection in Rust
48+
// . Dynamic Encodings in Rust
49+
// . Stable Codec
50+
// . Schema Evolution as Commit Merges

0 commit comments

Comments
 (0)