on master help sign in
gall-guide: more fang suggestions
3e92ebdtinnus-napbus
content/docs/userspace/gall-guide/1-arvo.md+10−11
@@ -50,13 +50,13 @@ Here's a brief summary of each of the vanes:
50 unless you specifically wanted to read and write files.
50 unless you specifically wanted to read and write files.
51
51
52- **Dill**: Terminal driver vane. You would not typically interact with Dill
52- **Dill**: Terminal driver vane. You would not typically interact with Dill
53− directly; printing messages to the terminal is usually done with hinting runes
53+ directly; printing debug messages to the terminal is usually done with hinting runes
54 and functions rather than tasks to Dill, and CLI apps are mediated by a
54 and functions rather than tasks to Dill, and CLI apps are mediated by a
55 sub-module of the `%hood` system agent called `%drum`. CLI apps will not be touched
55 sub-module of the `%hood` system agent called `%drum`. CLI apps will not be touched
56 on in this guide, but there's a separate [CLI
56 on in this guide, but there's a separate [CLI
57 Apps](/docs/hoon/guides/cli-tutorial) guide which covers them if you're
57 Apps](/docs/hoon/guides/cli-tutorial) guide which covers them if you're
58 interested.
58 interested.
59−- **Eyre**: Webserver vane. App front-ends are served via Eyre. It's possible to
59+- **Eyre**: Webserver vane. App web front-ends are served via Eyre. It's possible to
60 handle HTTP requests directly in a Gall agent (see the [Eyre
60 handle HTTP requests directly in a Gall agent (see the [Eyre
61 Guide](/docs/arvo/eyre/guide) for details), but usually you'd just serve a
61 Guide](/docs/arvo/eyre/guide) for details), but usually you'd just serve a
62 front-end [glob](/docs/userspace/dist/glob) via the `%docket` agent, so you'd
62 front-end [glob](/docs/userspace/dist/glob) via the `%docket` agent, so you'd
@@ -104,13 +104,13 @@ there's also:
104 If one of the API calls fails, your Gall agent is potentially left in a
104 If one of the API calls fails, your Gall agent is potentially left in a
105 strange intermediary state. Instead, you can put all the IO logic in a
105 strange intermediary state. Instead, you can put all the IO logic in a
106 separate thread which is completely atomic. That way the Gall agent only has
106 separate thread which is completely atomic. That way the Gall agent only has
107− to deal with the two conditions of success or failure. Writing threads are
107+ to deal with the two conditions of success or failure. Writing threads is
108 covered in a [separate guide](/docs/userspace/threads/basics/fundamentals),
108 covered in a [separate guide](/docs/userspace/threads/basics/fundamentals),
109 which you might like to work through after completing the Gall Guide.
109 which you might like to work through after completing the Gall Guide.
110
110
111- **Front-end**: Web UIs. It's possible for Gall agents to handle HTTP requests
111- **Front-end**: Web UIs. It's possible for Gall agents to handle HTTP requests
112− directly and dynamically produce responses, but it's more typical to have a
112+ directly and dynamically produce responses, but it's also possible to have a
113− separate [glob](/docs/userspace/dist/glob) of HTML, CSS, Javascript, images,
113+ static [glob](/docs/userspace/dist/glob) of HTML, CSS, Javascript, images,
114 etc, which are served to the client like an ordinary web app. Such front-end
114 etc, which are served to the client like an ordinary web app. Such front-end
115 files are typically managed by the `%docket` agent which serves them via Eyre.
115 files are typically managed by the `%docket` agent which serves them via Eyre.
116 The [software distribution guide](/docs/userspace/dist/guide) covers this in
116 The [software distribution guide](/docs/userspace/dist/guide) covers this in
@@ -151,7 +151,7 @@ some of these features in more detail later in the guide.
151## Desk Anatomy
151## Desk Anatomy
152
152
153The fundamental unit in Clay is a desk. Desks are kind of like git repositories.
153The fundamental unit in Clay is a desk. Desks are kind of like git repositories.
154−Urbit includes a few default desks: `%base`, `%garden`, `%landscape`, `%webterm`
154+By default, new urbits come with the following desks included: `%base`, `%garden`, `%landscape`, `%webterm`
155and `%bitcoin`.
155and `%bitcoin`.
156
156
157- `%base` - This desk contains the kernel as well as some core agents and utilities.
157- `%base` - This desk contains the kernel as well as some core agents and utilities.
@@ -166,8 +166,7 @@ upstream that sponsored ships (moons in the case of a planet, planets in the
166case of a star) sync their `%base` desk from. Any third-party apps you've
166case of a star) sync their `%base` desk from. Any third-party apps you've
167installed will also have their own desks.
167installed will also have their own desks.
168
168
169−Each desk will typically have a few default directories. The directories are as
169+Desks are typically assumed to store their files according to the following directory structure:
170−follows:
171
170
172```
171```
173desk
172desk
@@ -176,7 +175,7 @@ desk
176├── lib
175├── lib
177├── mar
176├── mar
178├── sur
177├── sur
179−├── sys <- on %base desk only
178+├── sys
180├── ted
179├── ted
181└── tests
180└── tests
182```
181```
@@ -190,7 +189,7 @@ desk
190- `sys`: Kernel files and standard library. Only the `%base` desk has this
189- `sys`: Kernel files and standard library. Only the `%base` desk has this
191 directory, it's omitted entirely in all other desks.
190 directory, it's omitted entirely in all other desks.
192- `ted`: Threads.
191- `ted`: Threads.
193−- `tests`: Unit tests, to be run by the `%test` thread. This is often omitted.
192+- `tests`: Unit tests, to be run by the `%test` thread. This is often omitted in distributed desks.
194
193
195This directory hierarchy is not strictly enforced, but most tools expect things
194This directory hierarchy is not strictly enforced, but most tools expect things
196to be in their right place. Any of these folders can be omitted if they'd
195to be in their right place. Any of these folders can be omitted if they'd
@@ -251,7 +250,7 @@ You should now have a general idea of the different parts of Arvo, but how does
251a Gall agent interact with these things?
250a Gall agent interact with these things?
252
251
253There are two basic ways of interacting with other parts of the system: by
252There are two basic ways of interacting with other parts of the system: by
254−scrying them, and by passing them messages and receiving messages in response.
253+scrying into them, and by passing them messages and receiving messages in response.
255There are also two basic things to interact with: vanes, and other agents.
254There are also two basic things to interact with: vanes, and other agents.
256
255
257- Scries: The scry system allows you to access the state of other agents and
256- Scries: The scry system allows you to access the state of other agents and