@@ -7,21 +7,21 @@ template = "doc.html"
7Here we describe what each of the primary folders present in the `%home` `desk`
7Here we describe what each of the primary folders present in the `%home` `desk`
8are used for. This organization is merely a convention, and the exact location
8are used for. This organization is merely a convention, and the exact location
9of any file does not affect its operation. That being said, some [Ford
9of any file does not affect its operation. That being said, some [Ford
10−runes](@/docs/arvo/ford/ford.md) are designed with this structure in mind, and
10+runes](/docs/arvo/ford/ford.md) are designed with this structure in mind, and
11applications such as dojo look in specific folders for code to run. Furthermore,
11applications such as dojo look in specific folders for code to run. Furthermore,
12this organization is not perfectly adhered to - sometimes you may find structure
12this organization is not perfectly adhered to - sometimes you may find structure
13definitions in `/lib`, for example.
13definitions in `/lib`, for example.
15- `/app` contains userspace applications, i.e. [Gall
15- `/app` contains userspace applications, i.e. [Gall
16− agents](@/docs/userspace/gall/gall.md).
16+ agents](/docs/userspace/gall/gall.md).
17- `/gen` contains generators. Many applications make use of generators, but
17- `/gen` contains generators. Many applications make use of generators, but
18 also each generator in this folder may be run from dojo using `+`. For
18 also each generator in this folder may be run from dojo using `+`. For
19 example, `/gen/foo/hoon` is run with `+foo`.
19 example, `/gen/foo/hoon` is run with `+foo`.
20- `/lib` contains libraries that may be shared by multiple agents, threads,
20- `/lib` contains libraries that may be shared by multiple agents, threads,
21 generators, etc. However, this is not the location of the standard libraries
21 generators, etc. However, this is not the location of the standard libraries
22 (see `/sys`). Libraries are imported from `/lib` with `/+`.
22 (see `/sys`). Libraries are imported from `/lib` with `/+`.
23−- `/mar` contains [mark](@/docs/arvo/clay/architecture.md#marks) definitions.
23+- `/mar` contains [mark](/docs/arvo/clay/architecture.md#marks) definitions.
24−- `/sur` contains shared [structure](@/docs/hoon/reference/rune/_index.md) definitions.
24+- `/sur` contains shared [structure](/docs/hoon/reference/rune/_index.md) definitions.
25 Whenever you expect structures to be used by code across multiple files, it
25 Whenever you expect structures to be used by code across multiple files, it
26 is recommended to place their shared structures in `/sur`. Structures are
26 is recommended to place their shared structures in `/sur`. Structures are
27 imported from `/sur` with `/-`.
27 imported from `/sur` with `/-`.
@@ -30,7 +30,7 @@ definitions in `/lib`, for example.
30 the exception to the rule - structures and functions that are central to
30 the exception to the rule - structures and functions that are central to
31 Hoon, Arvo, and its vanes, are all located within this folder rather than in
31 Hoon, Arvo, and its vanes, are all located within this folder rather than in
32 `/lib` and `/sur`. See [below](#sys) for more information on `/sys`.
32 `/lib` and `/sur`. See [below](#sys) for more information on `/sys`.
33−- `/ted` contains [threads](@/docs/userspace/threads/overview.md). These may be
33+- `/ted` contains [threads](/docs/userspace/threads/overview.md). These may be
34 run from dojo using `-`. For example, `/ted/foo/hoon` is run with `-foo`.
34 run from dojo using `-`. For example, `/ted/foo/hoon` is run with `-foo`.
35- `/tests` contains unit tests intended to be run using the `test` thread. To
35- `/tests` contains unit tests intended to be run using the `test` thread. To
36 run a particular test `+test-bar` in `/tests/foo.hoon` in dojo, enter `-test %/tests/foo/test-bar ~`. If a file is specified, every test in that file will
36 run a particular test `+test-bar` in `/tests/foo.hoon` in dojo, enter `-test %/tests/foo/test-bar ~`. If a file is specified, every test in that file will
@@ -44,13 +44,13 @@ dependencies is `hoon.hoon` -> `arvo.hoon` -> `lull.hoon` -> `zuse.hoon`. We
44give a brief description of each of them.
44give a brief description of each of them.
46- `hoon.hoon` contains the Hoon compiler and the [Hoon standard
46- `hoon.hoon` contains the Hoon compiler and the [Hoon standard
47− library](@/docs/hoon/reference/stdlib/table-of-contents.md). The Hoon
47+ library](/docs/hoon/reference/stdlib/table-of-contents.md). The Hoon
48 compiler is self-hosted. This is the first file loaded by the Nock virtual
48 compiler is self-hosted. This is the first file loaded by the Nock virtual
49− machine, [Vere](@/docs/vere/runtime.md), in order for it to learn how to
49+ machine, [Vere](/docs/vere/runtime.md), in order for it to learn how to
50 interpret Hoon. The kelvin version number is the subject of `hoon.hoon`,
50 interpret Hoon. The kelvin version number is the subject of `hoon.hoon`,
51 currently at 140. One may see this from dojo by inspecting the subject with
51 currently at 140. One may see this from dojo by inspecting the subject with
52 `.` and noting that `%140` is the final entry of the subject.
52 `.` and noting that `%140` is the final entry of the subject.
53−- `arvo.hoon` contains the [Arvo kernel](@/docs/arvo/overview.md) and
53+- `arvo.hoon` contains the [Arvo kernel](/docs/arvo/overview.md) and
54 additional structures and functions directly relevant to the kernel. This is
54 additional structures and functions directly relevant to the kernel. This is
55 Urbit's "traffic cop", and as such contains the structure definitions for
55 Urbit's "traffic cop", and as such contains the structure definitions for
56 call stacks such as `duct`s and `bone`s. Once Vere understands Hoon, it loads
56 call stacks such as `duct`s and `bone`s. Once Vere understands Hoon, it loads
@@ -60,10 +60,10 @@ give a brief description of each of them.
60 vanes, as well as a few functions. In particular, this includes the
60 vanes, as well as a few functions. In particular, this includes the
61 definitions of the `card`s utilized by each vane, each of which are
61 definitions of the `card`s utilized by each vane, each of which are
62 documented in their respective documentation. `lull.hoon` is loaded by the
62 documented in their respective documentation. `lull.hoon` is loaded by the
63− kernel during the [larval stage](@/docs/arvo/overview.md#larval-stage-core)
63+ kernel during the [larval stage](/docs/arvo/overview.md#larval-stage-core)
64 in order to prepare to create the vanes. `arvo.hoon` is the subject of `lull.hoon`.
64 in order to prepare to create the vanes. `arvo.hoon` is the subject of `lull.hoon`.
65- `zuse.hoon` is the Arvo standard library. It consists primarily of functions
65- `zuse.hoon` is the Arvo standard library. It consists primarily of functions
66 shared by the kernel and vanes, such as the ones related to
66 shared by the kernel and vanes, such as the ones related to
67− [cryptography](@/docs/arvo/reference/cryptography.md). `zuse.hoon` is loaded
67+ [cryptography](/docs/arvo/reference/cryptography.md). `zuse.hoon` is loaded
68 by the larval kernel following `lull.hoon`. `lull.hoon` is the subject of
68 by the larval kernel following `lull.hoon`. `lull.hoon` is the subject of
69 `zuse.hoon`. Then `zuse` is the subject of the vanes.
69 `zuse.hoon`. Then `zuse` is the subject of the vanes.