git.iko.soy/urbit.org
on master help sign in
rename to overview
commit09f1336e10761c8174638fcba7021e13638ab2b2 authorJosh Lehman <josh@starcity.com> dateThu 11 Mar 2021, 10:50 (6 years ago) parentfc7a090
11 files changed+23−21
compare with master
unifiedsplit
arvo/_index.md+3−3 arvo/ames/ames-api.md+1−1 arvo/ames/ames.md+1−1 arvo/dill/dill-api.md+3−3 arvo/jael/jael-api.md+1−1 arvo/arvo.md → arvo/overview.md+2−4 glossary/arvo.md+1−1 glossary/vane.md+1−1 landscape/_index.md+6−2 system-overview/arvo.md+3−3 system-overview/hoon.md+1−1
arvo/_index.md+3−3
@@ -7,21 +7,21 @@ aliases = ["/docs/learn/arvo/"]
77+++
88
99
10−## [Arvo](@/docs/arvo/arvo.md)
10+## [Arvo](@/docs/arvo/overview.md)
1111
1212Arvo is Urbit's functional operating system, written in [Hoon](@/docs/hoon/hoon-school/_index.md). It's composed of modules called _vanes_:
1313
1414
1515## Tutorials
1616
17−### [Move Trace](@/docs/arvo/move-trace.md)
17+### [Move Trace](@/docs/arvo/tutorials/move-trace.md)
1818
1919A walkthrough of what the Arvo kernel does to respond to a simple command.
2020
2121
2222## Concepts
2323
24−### [Input/Output](@/docs/arvo/io.md)
24+### [Input/Output](@/docs/arvo/concepts/io.md)
2525
2626Conceptual overview of how Arvo handles input and output.
2727
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
189189## `%init`
190190
191191`%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)
193193is completed. This initializes the vane. Jael is initialized first, followed by
194194other vanes such as Ames.
195195
arvo/ames/ames.md+1−1
@@ -28,7 +28,7 @@ vane or app, is defined in Ames.
2828This section summarizes the design of Ames. Beyond this section are deeper
2929elaborations on the concepts presented here.
3030
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.
3232
3333Ames receives packets as Arvo events and emits packets as Arvo
3434effects. 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`.
6868### `%boot`
6969
7070This `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
7272technically the first vane to be activated, via the `%boot` `task`, which then
7373send Jael (considered the the "true" first vane) an `%init` `task`, which then goes on to
7474call `%init` `task`s for other vanes (including Dill).
@@ -176,7 +176,7 @@ This `task` is not used.
176176### `%init`
177177
178178This `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
180180initial setup for Dill, such as setting the width of the console.
181181
182182Note that this is not actually the first `task` passed to Dill - see [%boot](#%boot).
@@ -353,7 +353,7 @@ This `task` returns no `gift`s.
353353
354354This `task` toggles verbose mode for all of Arvo, which is located here since
355355Dill 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).
357357
358358#### Accepts
359359
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
1414
1515This `task` is called once per ship during the vane initialization
1616phase 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
1818technical reasons, though we consider Jael to be the true "first" vane. This
1919`task` is only used for ships that will join the Ames network - fake ships (i.e.
2020made 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.
99
1010# Introduction
1111
12−## Overview
13−
1412This article is intended to provide a thorough summary of all of the most
1513important aspects of the Arvo kernel and how this functionality gives life to
1614the 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
253251This section requires an understanding of Hoon of at least the level of Chapter One of the [Hoon tutorial](@/docs/hoon/hoon-school/_index.md).
254252
255253After 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),
257255which applies many of the concepts covered below.
258256
259257## Overall structure
@@ -576,4 +574,4 @@ As of this writing, we have nine vanes, which each provide the following service
576574
577575Now that you've learned about the nuts and bolts of the Arvo kernel, why not
578576check 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
3434
3535### Further Reading
3636
37−- [The Arvo tutorial](@/docs/arvo/arvo.md): An in-depth technical
37+- [The Arvo tutorial](@/docs/arvo/overview.md): An in-depth technical
3838 guide to Arvo and its vanes.
3939- [The Technical Overview](@/docs/system-overview/_index.md): An
4040 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
2121
2222### Further Reading
2323
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"
55template = "sections/docs/chapters.html"
66+++
77
8+While not technically part of Urbit, Landscape serves as a reference
9+implementation for how to build applications in user space.
810
9−## [Landscape Architecture](@/docs/landscape/arch.md)
11+## [Landscape Architecture](@/docs/landscape/overview.md)
1012
1113An overview of how Landscape, our flagship client, is structured.
1214
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
1616`<output events, new state>`. Events are typed, and each has an explicit
1717call-stack structure indicating the event's source module in Arvo.
1818
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).
2020
2121Arvo modules are also called 'vanes'. Arvo's vanes are:
2222
@@ -28,6 +28,6 @@ Arvo modules are also called 'vanes'. Arvo's vanes are:
2828- [Dill](@/docs/arvo/dill/dill.md): terminal driver.
2929- [Eyre](@/docs/arvo/eyre/eyre.md): HTTP server.
3030- [Gall](@/docs/arvo/gall/gall.md): application sandbox and manager.
31−- [Iris](@/docs/glossary/iris.md): HTTP client.
32−- [Jael](@/docs/glossary/jael.md): Public and private key storage.
31+- [Iris](@/docs/arvo/iris/iris-api.md): HTTP client.
32+- [Jael](@/docs/arvo/jael/jael-api.md): Public and private key storage.
3333
system-overview/hoon.md+1−1
@@ -17,7 +17,7 @@ about 3000 lines of Hoon.
1717
1818## Further Reading
1919
20−### [Hoon Overview](@/docs/hoon/whyhoon.md)
20+### [Hoon Overview](@/docs/hoon/overview.md)
2121
2222Learn why we created a new language to build Urbit in.
2323