git.iko.soy/urbit.org
on master help sign in
rename to overview
09f1336Josh Lehman
arvo/_index.md+3−3
compare with master
unifiedsplit
@@ -7,21 +7,21 @@ aliases = ["/docs/learn/arvo/"]
7+++
7+++
8
8
9
9
10−## [Arvo](@/docs/arvo/arvo.md)
10+## [Arvo](@/docs/arvo/overview.md)
11
11
12Arvo is Urbit's functional operating system, written in [Hoon](@/docs/hoon/hoon-school/_index.md). It's composed of modules called _vanes_:
12Arvo is Urbit's functional operating system, written in [Hoon](@/docs/hoon/hoon-school/_index.md). It's composed of modules called _vanes_:
13
13
14
14
15## Tutorials
15## Tutorials
16
16
17−### [Move Trace](@/docs/arvo/move-trace.md)
17+### [Move Trace](@/docs/arvo/tutorials/move-trace.md)
18
18
19A walkthrough of what the Arvo kernel does to respond to a simple command.
19A walkthrough of what the Arvo kernel does to respond to a simple command.
20
20
21
21
22## Concepts
22## Concepts
23
23
24−### [Input/Output](@/docs/arvo/io.md)
24+### [Input/Output](@/docs/arvo/concepts/io.md)
25
25
26Conceptual overview of how Arvo handles input and output.
26Conceptual overview of how Arvo handles input and output.
27
27
arvo/ames/ames-api.md+1−1
@@ -189,7 +189,7 @@ Ames does not `give` a `gift` in response to a `%crud` `task`, but it does
189## `%init`
189## `%init`
190
190
191`%init` is called a single time during the very first boot process, immediately
191`%init` is called a single time during the very first boot process, immediately
192−after the [larval stage](@/docs/arvo/arvo.md#larval-stage-core)
192+after the [larval stage](@/docs/arvo/overview.md#larval-stage-core)
193is completed. This initializes the vane. Jael is initialized first, followed by
193is completed. This initializes the vane. Jael is initialized first, followed by
194other vanes such as Ames.
194other vanes such as Ames.
195
195
arvo/ames/ames.md+1−1
@@ -28,7 +28,7 @@ vane or app, is defined in Ames.
28This section summarizes the design of Ames. Beyond this section are deeper
28This section summarizes the design of Ames. Beyond this section are deeper
29elaborations on the concepts presented here.
29elaborations on the concepts presented here.
30
30
31−Ames extends [Arvo's](@/docs/arvo/arvo.md) `%pass`/`%give` `move` semantics across the network.
31+Ames extends [Arvo's](@/docs/arvo/overview.md) `%pass`/`%give` `move` semantics across the network.
32
32
33Ames receives packets as Arvo events and emits packets as Arvo
33Ames receives packets as Arvo events and emits packets as Arvo
34effects. The runtime is responsible for transferring the bytes in
34effects. The runtime is responsible for transferring the bytes in
arvo/dill/dill-api.md+3−3
@@ -68,7 +68,7 @@ Dill returns no `gift` in response to a `%blew` `task`.
68### `%boot`
68### `%boot`
69
69
70This `task` is used only once, when Arvo first enters the [adult
70This `task` is used only once, when Arvo first enters the [adult
71−stage](@/docs/arvo/arvo.md#structural-interface-core). Dill is
71+stage](@/docs/arvo/overview.md#structural-interface-core). Dill is
72technically the first vane to be activated, via the `%boot` `task`, which then
72technically the first vane to be activated, via the `%boot` `task`, which then
73send Jael (considered the the "true" first vane) an `%init` `task`, which then goes on to
73send Jael (considered the the "true" first vane) an `%init` `task`, which then goes on to
74call `%init` `task`s for other vanes (including Dill).
74call `%init` `task`s for other vanes (including Dill).
@@ -176,7 +176,7 @@ This `task` is not used.
176### `%init`
176### `%init`
177
177
178This `task` is called only once, when Arvo first enters the [adult
178This `task` is called only once, when Arvo first enters the [adult
179−stage](@/docs/arvo/arvo.md#structural-interface-core). It performs
179+stage](@/docs/arvo/overview.md#structural-interface-core). It performs
180initial setup for Dill, such as setting the width of the console.
180initial setup for Dill, such as setting the width of the console.
181
181
182Note that this is not actually the first `task` passed to Dill - see [%boot](#%boot).
182Note that this is not actually the first `task` passed to Dill - see [%boot](#%boot).
@@ -353,7 +353,7 @@ This `task` returns no `gift`s.
353
353
354This `task` toggles verbose mode for all of Arvo, which is located here since
354This `task` toggles verbose mode for all of Arvo, which is located here since
355Dill is the vane that prints errors. To be precise, `%verb` toggles the laconic
355Dill is the vane that prints errors. To be precise, `%verb` toggles the laconic
356−bit `lac` in the [Arvo state](@/docs/arvo/arvo.md#the-state).
356+bit `lac` in the [Arvo state](@/docs/arvo/overview.md#the-state).
357
357
358#### Accepts
358#### Accepts
359
359
arvo/jael/jael-api.md+1−1
@@ -14,7 +14,7 @@ each `task` that Jael can be `%pass`ed, and which `gift`(s) Jael can `%give` in
14
14
15This `task` is called once per ship during the vane initialization
15This `task` is called once per ship during the vane initialization
16phase immediately following the beginning of the [adult
16phase immediately following the beginning of the [adult
17−stage](@/docs/arvo/arvo.md#structural-interface-core). This `task` is `%pass`ed to Jael by Dill, as Dill is the first vane to be loaded for
17+stage](@/docs/arvo/overview.md#structural-interface-core). This `task` is `%pass`ed to Jael by Dill, as Dill is the first vane to be loaded for
18technical reasons, though we consider Jael to be the true "first" vane. This
18technical reasons, though we consider Jael to be the true "first" vane. This
19`task` is only used for ships that will join the Ames network - fake ships (i.e.
19`task` is only used for ships that will join the Ames network - fake ships (i.e.
20made with `./urbit -F zod`) use the `%fake` `task` instead.
20made with `./urbit -F zod`) use the `%fake` `task` instead.
arvo/arvo.md → arvo/overview.mdrenamed+2−4
@@ -9,8 +9,6 @@ Arvo, also called Urbit OS, is our operating system.
9
9
10# Introduction
10# Introduction
11
11
12−## Overview
13−
14This article is intended to provide a thorough summary of all of the most
12This article is intended to provide a thorough summary of all of the most
15important aspects of the Arvo kernel and how this functionality gives life to
13important aspects of the Arvo kernel and how this functionality gives life to
16the ambitions of the Urbit platform. We work on two levels: a conceptual level
14the ambitions of the Urbit platform. We work on two levels: a conceptual level
@@ -253,7 +251,7 @@ The Arvo kernel, stored in `sys/arvo.hoon`, is about 1k lines of Hoon whose prim
253This section requires an understanding of Hoon of at least the level of Chapter One of the [Hoon tutorial](@/docs/hoon/hoon-school/_index.md).
251This section requires an understanding of Hoon of at least the level of Chapter One of the [Hoon tutorial](@/docs/hoon/hoon-school/_index.md).
254
252
255After concluding this section, the reader is encouraged to follow along with the
253After concluding this section, the reader is encouraged to follow along with the
256−[move trace tutorial](@/docs/arvo/move-trace.md),
254+[move trace tutorial](@/docs/arvo/tutorials/move-trace.md),
257which applies many of the concepts covered below.
255which applies many of the concepts covered below.
258
256
259## Overall structure
257## Overall structure
@@ -576,4 +574,4 @@ As of this writing, we have nine vanes, which each provide the following service
576
574
577Now that you've learned about the nuts and bolts of the Arvo kernel, why not
575Now that you've learned about the nuts and bolts of the Arvo kernel, why not
578check it out in action? An in-depth "move trace" tutorial for running a timer app
576check it out in action? An in-depth "move trace" tutorial for running a timer app
579−is available [here](@/docs/arvo/move-trace.md).
577+is available [here](@/docs/arvo/tutorials/move-trace.md).
glossary/arvo.md+1−1
@@ -34,7 +34,7 @@ A ship creates its own copy of Arvo via a bootstrap sequence known as a
34
34
35### Further Reading
35### Further Reading
36
36
37−- [The Arvo tutorial](@/docs/arvo/arvo.md): An in-depth technical
37+- [The Arvo tutorial](@/docs/arvo/overview.md): An in-depth technical
38 guide to Arvo and its vanes.
38 guide to Arvo and its vanes.
39- [The Technical Overview](@/docs/system-overview/_index.md): An
39- [The Technical Overview](@/docs/system-overview/_index.md): An
40 overview of all of Urbit.
40 overview of all of Urbit.
glossary/vane.md+1−1
@@ -21,4 +21,4 @@ A **vane** is an [Arvo](../arvo) kernel module that performs essential system op
21
21
22### Further Reading
22### Further Reading
23
23
24−- [The Arvo tutorial](@/docs/arvo/arvo.md): An in-depth technical guide to Arvo and its vanes.
24+- [The Arvo tutorial](@/docs/arvo/overview.md): An in-depth technical guide to Arvo and its vanes.
landscape/_index.md+6−2
@@ -5,9 +5,13 @@ sort_by = "weight"
5template = "sections/docs/chapters.html"
5template = "sections/docs/chapters.html"
6+++
6+++
7
7
8+While not technically part of Urbit, Landscape serves as a reference
9+implementation for how to build applications in user space.
8
10
9−## [Landscape Architecture](@/docs/landscape/arch.md)
11+## [Landscape Architecture](@/docs/landscape/overview.md)
10
12
11An overview of how Landscape, our flagship client, is structured.
13An overview of how Landscape, our flagship client, is structured.
12
14
13−## [API Reference](@/docs/landscape/apiref/_index.md)
15+## [API Reference](@/docs/landscape/reference/_index.md)
16+
17+API documentation about specific agents that comprise Landscape.
system-overview/arvo.md+3−3
@@ -16,7 +16,7 @@ appropriate OS module. The result of each Vere 'poke' is a pair of
16`<output events, new state>`. Events are typed, and each has an explicit
16`<output events, new state>`. Events are typed, and each has an explicit
17call-stack structure indicating the event's source module in Arvo.
17call-stack structure indicating the event's source module in Arvo.
18
18
19−For a more in-depth technical introduction, see [Arvo Overview](@/docs/arvo/arvo.md).
19+For a more in-depth technical introduction, see [Arvo Overview](@/docs/arvo/overview.md).
20
20
21Arvo modules are also called 'vanes'. Arvo's vanes are:
21Arvo modules are also called 'vanes'. Arvo's vanes are:
22
22
@@ -28,6 +28,6 @@ Arvo modules are also called 'vanes'. Arvo's vanes are:
28- [Dill](@/docs/arvo/dill/dill.md): terminal driver.
28- [Dill](@/docs/arvo/dill/dill.md): terminal driver.
29- [Eyre](@/docs/arvo/eyre/eyre.md): HTTP server.
29- [Eyre](@/docs/arvo/eyre/eyre.md): HTTP server.
30- [Gall](@/docs/arvo/gall/gall.md): application sandbox and manager.
30- [Gall](@/docs/arvo/gall/gall.md): application sandbox and manager.
31−- [Iris](@/docs/glossary/iris.md): HTTP client.
31+- [Iris](@/docs/arvo/iris/iris-api.md): HTTP client.
32−- [Jael](@/docs/glossary/jael.md): Public and private key storage.
32+- [Jael](@/docs/arvo/jael/jael-api.md): Public and private key storage.
33
33
system-overview/hoon.md+1−1
@@ -17,7 +17,7 @@ about 3000 lines of Hoon.
17
17
18## Further Reading
18## Further Reading
19
19
20−### [Hoon Overview](@/docs/hoon/whyhoon.md)
20+### [Hoon Overview](@/docs/hoon/overview.md)
21
21
22Learn why we created a new language to build Urbit in.
22Learn why we created a new language to build Urbit in.
23
23