git.iko.soy/urbit.org
on master help sign in
Organize Hall documentation
4251b1fKeaton Dunsford
docs/hall.mdnew file+12
compare with master
unifiedsplit
@@ -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+---
1
8
2# Hall architecture
9# Hall architecture
3
10
4This 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.
11This 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.
5
12
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).
7
14
8## Table of contents
15## Table of contents
9
16
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+---
1
8
2# Hall interface
9# Hall interface
3
10
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+---
1
7
2# The new Gall model
8# The new Gall model
3
9
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.
5
11
6New Gall has not yet fully solidified. As such, structure and naming are tentative to change.
12New Gall has not yet fully solidified. As such, structure and naming are tentative to change.
7
13
@@ -102,7 +108,7 @@ For a more verbose specification of all of these, see the new Gall spec.
102## By example
108## By example
103
109
104To 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.
110To 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).)
106
112
107### State & deltas
113### State & deltas
108
114
@@ -242,4 +248,5 @@ While it's technically easier to produce a list in reverse order, semantically i
242
248
243## Further reading
249## Further reading
244
250
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+```
1:: counter app
11:: counter app
2:: new gall example, may or may not compile.
12:: new gall example, may or may not compile.
3::
13::
@@ -84,3 +94,4 @@
84::
94::
85:: not pictured: ++path-to-query
95:: not pictured: ++path-to-query
86--
96--
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+```
1=> |%
15=> |%
2 --
16 --
3|* $: :> vinyl: historical state (including version)
17|* $: :> vinyl: historical state (including version)
@@ -147,3 +161,4 @@
147 ^- (list delta)
161 ^- (list delta)
148 !!
162 !!
149--
163--
164+```