git.iko.soy/urbit.org
on master help sign in
Organize Hall documentation
commit4251b1f76f54948f4ac27733adc62caec9d676b1 authorKeaton Dunsford <keaton@tlon.io> dateThu 7 Dec 2017, 18:43 (9 years ago) parent946ba07
6 files changed+63−4
compare with master
unifiedsplit
docs/hall.md+12 docs/hall/architecture.md+8−1 docs/hall/interface.md+7 docs/hall/gall.md → docs/hall/new-gall.md+10−3 docs/hall/gall-eg.hoon → docs/hall/new-gall/example.md+11 docs/hall/gall-spec_orig.hoon → docs/hall/new-gall/spec.md+15
docs/hall.mdnew file+12
@@ -0,0 +1,12 @@
1+---
2+navhome: /docs/
3+title: Hall
4+---
5+
6+# Hall
7+
8+Hall is the Urbit messaging and notifications protocol. Read up on Hall's
9+architecture, its interfaces and the new Gall model it's built to target
10+in this documentation section.
11+
12+<list/>
docs/hall/architecture.md+8−1
@@ -1,9 +1,16 @@
1+---
2+navhome: /docs/
3+navuptwo: true
4+next: true
5+sort: 1
6+title: Hall architecture
7+---
18
29# Hall architecture
310
411This document is complemented by Hall's source code, but doesn't require it. Definitions of data structures, code snippets and diagrams will be provided where useful.
512
6−Hall's implementation is structured according to the new Gall model. Familiarity with its concepts is assumed. See [the new Gall model](gall.md).
13+Hall's implementation is structured according to the new Gall model. Familiarity with its concepts is assumed. See [the new Gall model](../new-gall).
714
815## Table of contents
916
docs/hall/interface.md+7
@@ -1,3 +1,10 @@
1+---
2+navhome: /docs/
3+navuptwo: true
4+next: true
5+sort: 2
6+title: Hall interface
7+---
18
29# Hall interface
310
docs/hall/gall.md → docs/hall/new-gall.mdrenamed+10−3
@@ -1,7 +1,13 @@
1+---
2+navhome: /docs/
3+navuptwo: true
4+sort: 3
5+title: The new Gall model
6+---
17
28# The new Gall model
39
4−This document is complemented by the source code of applications that use the new Gall model (like [hall](https://github.com/urbit/arvo/blob/master/app/hall.hoon)), but doesn't require it. Code snippets will be provided where useful. Some knowledge of Hoon and the functioning of Hoon apps is assumed.
10+This document is complemented by the source code of applications that use the new Gall model (like [Hall](https://github.com/urbit/arvo/blob/master/app/hall.hoon)), but doesn't require it. Code snippets will be provided where useful. Some knowledge of Hoon and the functioning of Hoon apps is assumed.
511
612New Gall has not yet fully solidified. As such, structure and naming are tentative to change.
713
@@ -102,7 +108,7 @@ For a more verbose specification of all of these, see the new Gall spec.
102108## By example
103109
104110To help solidify this and see what this would looks like in the wild, let's make a very simple example app. It's a counter that can go up and down, and can be queried for its value, or whether or not its value is a multiple of x. First we write all the structures that will support our app, and then we implement the arms that operate on them.
105−(The app code in its entirety can be found [here](gall-eg.hoon).)
111+(The app code in its entirety can be found [here](example).)
106112
107113### State & deltas
108114
@@ -242,4 +248,5 @@ While it's technically easier to produce a list in reverse order, semantically i
242248
243249## Further reading
244250
245−[Original new Gall spec by ~sorreg-namtyv](gall-spec_orig.hoon)
251+- [Original new-Gall spec by ~sorreg-namtyv](spec)
252+- [A new-Gall example app](example)
docs/hall/gall-eg.hoon → docs/hall/new-gall/example.mdrenamed+11
@@ -1,3 +1,13 @@
1+---
2+navhome: /docs/
3+next: true
4+sort: 2
5+title: A new-Gall example app
6+---
7+
8+# A new-Gall example app
9+
10+```
111:: counter app
212:: new gall example, may or may not compile.
313::
@@ -84,3 +94,4 @@
8494::
8595:: not pictured: ++path-to-query
8696--
97+```
docs/hall/gall-spec_orig.hoon → docs/hall/new-gall/spec.mdrenamed+15
@@ -1,3 +1,17 @@
1+---
2+navhome: /docs/
3+next: true
4+sort: 1
5+title: The original new-Gall spec
6+---
7+
8+# The original new-Gall spec
9+
10+`~sorreg-namtyv`
11+
12+<br />
13+
14+```
115=> |%
216 --
317|* $: :> vinyl: historical state (including version)
@@ -147,3 +161,4 @@
147161 ^- (list delta)
148162 !!
149163--
164+```