git.iko.soy/urbit.org
on master help sign in
tighten up formatting
d7f7e13Josh Lehman
system-overview/_index.md+11−8
compare with master
unifiedsplit
@@ -10,15 +10,18 @@ network of general-purpose personal servers. Each server on this network is a
10deterministic computer called an 'urbit' that runs on a Unix-based virtual
10deterministic computer called an 'urbit' that runs on a Unix-based virtual
11machine.
11machine.
12
12
13−The current Urbit stack includes (among other things):
13+The Urbit stack is primarily comprised of:
14
14
15−- Arvo: the functional operating system of each urbit, written in Hoon.
15+- [Arvo](@/docs/system-overview/arvo.md): the functional operating system of
16−- Azimuth: the Urbit identity layer, built on the Ethereum blockchain.
16+ each urbit, written in Hoon.
17+- [Hoon](@/docs/system-overview/hoon.md): a strictly typed functional
17−- Hoon: a strictly typed functional programming language whose standard library
18+ programming language whose standard library includes a Hoon-to-Nock compiler.
18− includes a Hoon-to-Nock compiler.
19+- [Nock](@/docs/system-overview/nock.md): a low-level combinator language whose
19−- Nock: a low-level combinator language whose formal specification fits readably on a t-shirt.
20+ formal specification fits readably on a t-shirt.
20−- Vere: a Nock interpreter and Unix-based virtual machine that mediates between
21+- [Vere](@/docs/system-overview/vere.md): a Nock interpreter and Unix-based
21− each urbit and the Unix software layer.
22+ virtual machine that mediates between each urbit and the Unix software layer.
23+- [Azimuth](@/docs/system-overview/azimuth.md): the Urbit identity layer, built
24+ on the Ethereum blockchain.
22
25
23## Anatomy of a personal server
26## Anatomy of a personal server
24
27
system-overview/arvo.md+10−10
@@ -4,17 +4,17 @@ weight = 10
4template = "doc.html"
4template = "doc.html"
5+++
5+++
6
6
7+Arvo is a purely functional,
7−Arvo is a purely functional, [non-preemptive](https://en.wikipedia.org/wiki/Cooperative_multitasking)
8+[non-preemptive](https://en.wikipedia.org/wiki/Cooperative_multitasking) OS,
8−OS, written in Hoon, that serves as the event manager of your urbit.
9+written in Hoon, that serves as the event manager of your urbit. It can upgrade
9−It can upgrade itself from over the network without downtime. The Arvo kernel
10+itself from over the network without downtime. The Arvo kernel proper is quite
10−proper is quite simple -- it's only about 600 lines of code, excluding its
11+simple -- it's only about 600 lines of code, excluding its various modules.
11−various modules.
12
12
13−The Urbit transition function is implemented in Arvo. Upon being 'poked' by
13+The Urbit transition function is implemented in Arvo. Upon being 'poked' by Vere
14−Vere with the pair of `<input event, state>`, Arvo directs the event to the
14+with the pair of `<input event, state>`, Arvo directs the event to the
15−appropriate OS module. The result of each Vere 'poke' is a pair of
15+appropriate OS module. The result of each Vere 'poke' is a pair of `<output
16−`<output events, new state>`. Events are typed, and each has an explicit
16+events, new state>`. Events are typed, and each has an explicit call-stack
17−call-stack structure indicating the event's source module in Arvo.
17+structure indicating the event's source module in Arvo.
18
18
19For a more in-depth technical introduction, see [Arvo Overview](@/docs/arvo/overview.md).
19For a more in-depth technical introduction, see [Arvo Overview](@/docs/arvo/overview.md).
20
20
system-overview/azimuth.md+5−8
@@ -25,13 +25,10 @@ is the neighborhood that you live in.
25
25
26## Further Reading
26## Further Reading
27
27
28−### [Azimuth](@/docs/azimuth/azimuth.md)
28+* [Azimuth](@/docs/azimuth/azimuth.md): An overview of the Ethereum-based public
29−
30−An overview of the Ethereum-based public key infrastructure utilized by Urbit.
29+ key infrastructure utilized by Urbit.
31−
32−### [Advanced Azimuth Tools](@/docs/azimuth/advanced-azimuth-tools.md)
30+* [Advanced Azimuth Tools](@/docs/azimuth/advanced-azimuth-tools.md):
33−
34−Expert-level tooling for generating, signing, and sending Azimuth-related
31+ Expert-level tooling for generating, signing, and sending Azimuth-related
35−transactions from within Urbit itself.
32+ transactions from within Urbit itself.
36
33
37
34
system-overview/hoon.md+8−16
@@ -17,20 +17,12 @@ about 3000 lines of Hoon.
17
17
18## Further Reading
18## Further Reading
19
19
20−### [Hoon Overview](@/docs/hoon/overview.md)
20+* [Hoon Overview](@/docs/hoon/overview.md): Learn why we created a new language
21−
22−Learn why we created a new language to build Urbit in.
21+ to build Urbit in.
23−
24−### [Hoon School](@/docs/hoon/hoon-school/_index.md)
22+* [Hoon School](@/docs/hoon/hoon-school/_index.md): A collection of tutorials
25−
26−A collection of tutorials designed to teach you the Hoon language.
23+ designed to teach you the Hoon language.
27−
28−### [Guides](@/docs/hoon/guides/_index.md)
24+* [Guides](@/docs/hoon/guides/_index.md): Guides to specific Hoon tasks,
29−
30−Guides to specific Hoon tasks, including testing, command-line interface apps,
25+including testing, command-line interface apps, and parsing.
31−and parsing.
32−
33−### [Reference](@/docs/hoon/reference/_index.md)
26+* [Reference](@/docs/hoon/reference/_index.md): Reference material primarily
34−
35−Reference material primarily intended for Hoon developers with some experience.
27+ intended for Hoon developers with some experience.
36
28
system-overview/nock.md+8−19
@@ -22,24 +22,13 @@ pair of nouns. Nouns are acyclic and expose no pointer equality test.
22
22
23## Further Reading
23## Further Reading
24
24
25−### [Nock Definition](@/docs/nock/definition.md)
25+* [Nock Definition](@/docs/nock/definition.md): The Nock specification.
26−
27−The Nock specification.
28−
29−### [An explanation of Nock](@/docs/nock/explanation.md)
26+* [An explanation of Nock](@/docs/nock/explanation.md): A comprehensive
30−
31−A comprehensive walkthrough of the Nock spec.
27+ walkthrough of the Nock spec.
32−
33−### [Nock by hand](@/docs/nock/example.md)
28+* [Nock by hand](@/docs/nock/example.md): Learn Nock by example.
34−
35−Learn Nock by example.
36−
37−### [Nock Implementations](@/docs/nock/implementations.md)
29+* [Nock Implementations](@/docs/nock/implementations.md): The many ways that
38−
39−The many ways that Nock has been implemented.
30+ Nock has been implemented.
40−
41−### [Nock for Everyday Coders](https://blog.timlucmiptev.space/part1.html)
31+* [Nock for Everyday Coders](https://blog.timlucmiptev.space/part1.html): A
42−
43−A comprehensive guide to Nock by community member `~timluc-miptev`.
32+ comprehensive guide to Nock by community member `~timluc-miptev`.
44
33
45
34
system-overview/vere.md+12−23
@@ -31,26 +31,15 @@ licensed.
31
31
32## Further Reading
32## Further Reading
33
33
34−### [C runtime system](@/docs/vere/runtime.md)
34+* [C runtime system](@/docs/vere/runtime.md): The Urbit interpreter is built on
35−
36−The Urbit interpreter is built on a Nock runtime system written
37−in C, `u3`. This section is a relatively complete description.
35+a Nock runtime system written in C, `u3`. This section is a relatively complete
38−
36+description.
39−### [c3: C in Urbit](@/docs/vere/c.md)
40−
41−Under `u3` is the simple `c3` layer, which is just how we write C
37+* [c3: C in Urbit](@/docs/vere/c.md): Under `u3` is the simple `c3` layer, which
42−in Urbit.
38+is just how we write C in Urbit.
43−
44−### [u3: Land of nouns](@/docs/vere/nouns.md)
39+* [u3: Land of nouns](@/docs/vere/nouns.md): The division between `c3` and `u3`
45−
46−The division between `c3` and `u3` is that you could theoretically
47−imagine using `c3` as just a generic C environment. Anything to do
40+is that you could theoretically imagine using `c3` as just a generic C
48−with nouns is in `u3`.
41+environment. Anything to do with nouns is in `u3`.
49−
50−### [u3: API overview by prefix](@/docs/vere/api.md)
42+* [u3: API overview by prefix](@/docs/vere/api.md): A walkthrough of each of the
51−
52−A walkthrough of each of the `u3` modules.
43+ `u3` modules.
53−
54−### [How to write a jet](@/docs/vere/jetting.md)
44+* [How to write a jet](@/docs/vere/jetting.md): A jetting guide for new Urbit
55−
56−A jetting guide by for new Urbit developers.
45+ developers.