on master help sign in
tasks: fix links
commitb745730c41ef6d4e6e51d18ce2d61332ae672e24 authortinnus-napbus <admin@tinnus-napbus.xyz> dateWed 28 Jul 2021, 23:58 (5 years ago) parenta19586b
1 file changed+12−12
content/docs/arvo/jael/tasks.md+12−12
content/docs/arvo/jael/tasks.md+12−12
@@ -6,7 +6,7 @@ template = "doc.html"
66
77This document details all the `task`s you may wish to send Jael, as well as the `gift`s you'll receive in response.
88
9−You may also wish to reference the [Data Types](@/docs/arvo/jael/data-types.md) document for details of the types referenced here, and the [Examples](@/docs/arvo/jael/examples.md) document for practical examples of using these `task`s.
9+You may also wish to reference the [Data Types](/docs/arvo/jael/data-types) document for details of the types referenced here, and the [Examples](/docs/arvo/jael/examples) document for practical examples of using these `task`s.
1010
1111## `%dawn`
1212
@@ -16,7 +16,7 @@ You may also wish to reference the [Data Types](@/docs/arvo/jael/data-types.md)
1616
1717Boot from keys.
1818
19−This `task` is called once per ship during the vane initialization phase immediately following the beginning of the [adult 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 technical reasons, though we consider Jael to be the true "first" vane. This `task` is only used for ships that will join the Ames network - fake ships (i.e. made with `./urbit -F zod`) use the [%fake](#fake) `task` instead.
19+This `task` is called once per ship during the vane initialization phase immediately following the beginning of the [adult stage](/docs/arvo/overview#structural-interface-core). This `task` is `%pass`ed to Jael by Dill, as Dill is the first vane to be loaded for technical reasons, though we consider Jael to be the true "first" vane. This `task` is only used for ships that will join the Ames network - fake ships (i.e. made with `./urbit -F zod`) use the [%fake](#fake) `task` instead.
2020
2121`%dawn` is used to perform a sequence of initialization tasks related to saving information about Azimuth and the Ames network and booting other vanes for the first time. Upon receipt of a `%dawn` `task`, Jael will:
2222
@@ -30,7 +30,7 @@ This `task` is called once per ship during the vane initialization phase immedia
3030- `%slip` a `%init` `task` to Ames, Clay, Gall, Dill, and Eyre, and `%give` an `%init`
3131 `gift` to Arvo, which then informs Unix that the initialization process has concluded.
3232
33−This `task` takes a [$dawn-event](@/docs/arvo/jael/data-types.md#dawn-event) as its argument.
33+This `task` takes a [$dawn-event](/docs/arvo/jael/data-types#dawn-event) as its argument.
3434
3535You would not use this `task` manually.
3636
@@ -68,7 +68,7 @@ Set Ethereum source.
6868
6969Sets the source that the public keys for a set of `ship`s should be obtained from. This can either be a Gall app that communicates with an Ethereum node such as `%azimuth-tracker`, as in the case of galaxies, stars, and planets, or a ship, as in the case of moons.
7070
71−`whos` is the set of ships whose key data source is to be monitored. The [$source](@/docs/arvo/jael/data-types.md#source) is either a ship or the name of a Gall app to use as a source. A `%listen` `task` with empty `whos` will set the default source. When the `source` is a ship, Jael will obtain public keys for ships in `(set ship)` from the given ship. By default, the `source` for a moon will be the planet that spawned that moon.
71+`whos` is the set of ships whose key data source is to be monitored. The [$source](/docs/arvo/jael/data-types#source) is either a ship or the name of a Gall app to use as a source. A `%listen` `task` with empty `whos` will set the default source. When the `source` is a ship, Jael will obtain public keys for ships in `(set ship)` from the given ship. By default, the `source` for a moon will be the planet that spawned that moon.
7272
7373You are unlikely to use this `task` manually.
7474
@@ -92,7 +92,7 @@ This `task` is deprecated and does not perform any actions.
9292
9393Register moon keys or otherwise administer a moon.
9494
95−This is what is sent to Jael by `%hood` behind the scenes when you run `|moon`, `|moon-breach` or `|moon-cycle-keys`. The `ship` field is the moon's `@p`. The [$udiff:point](@/docs/arvo/jael/data-types.md#udiff-point) will contain the bunt of an [$id:block](@/docs/arvo/jael/data-types.md#id-block) (since moons aren't registered in Azimuth) and one of the `udiff` actions depending on what you want to do.
95+This is what is sent to Jael by `%hood` behind the scenes when you run `|moon`, `|moon-breach` or `|moon-cycle-keys`. The `ship` field is the moon's `@p`. The [$udiff:point](/docs/arvo/jael/data-types#udiff-point) will contain the bunt of an [$id:block](/docs/arvo/jael/data-types#id-block) (since moons aren't registered in Azimuth) and one of the `udiff` actions depending on what you want to do.
9696
9797### Returns
9898
@@ -116,7 +116,7 @@ Jael does not return a `gift` in response to a `%nuke` `task`.
116116
117117### Examples
118118
119−See the [%public-keys and %nuke](@/docs/arvo/jael/examples.md#public-keys-and-nuke) section of the Examples document for an example of using `%nuke` to cancel a `%public-keys` subscription. See the thread in the [%private-keys](@/docs/arvo/jael/examples.md#private-keys) example for cancelling a `%private-keys` subscription.
119+See the [%public-keys and %nuke](/docs/arvo/jael/examples#public-keys-and-nuke) section of the Examples document for an example of using `%nuke` to cancel a `%public-keys` subscription. See the thread in the [%private-keys](/docs/arvo/jael/examples#private-keys) example for cancelling a `%private-keys` subscription.
120120
121121## `%private-keys`
122122
@@ -140,7 +140,7 @@ The `life` is the current life of the ship and the `vein` `map` contains the pri
140140
141141### Example
142142
143−See the [%private-keys](@/docs/arvo/jael/examples.md#private-keys) section of the Examples document for a practical example.
143+See the [%private-keys](/docs/arvo/jael/examples#private-keys) section of the Examples document for a practical example.
144144
145145## `%public-keys`
146146
@@ -160,13 +160,13 @@ Jael responds to a `%public-keys` `task` with `%public-keys` `gift`s which look
160160[%public-keys =public-keys-result]
161161```
162162
163−The [$public-keys-result](@/docs/arvo/jael/data-types.md#public-keys-result) contains whatever changes have occurred.
163+The [$public-keys-result](/docs/arvo/jael/data-types#public-keys-result) contains whatever changes have occurred.
164164
165165Upon subscription, Jael will immeditely respond with a `%public-keys` `gift` containing a `%full` `public-keys-result` with the public key for each `life` up until the current one for each `ship` specified in the original `task`. After than, Jael will send a `%public-keys` `gift` with either a `%diff` or `%breach` `public-keys-result` each time a change occurs for any of the `ship`s to which you're subscribed.
166166
167167### Example
168168
169−See the [%public-keys and %nuke](@/docs/arvo/jael/examples.md#public-keys-and-nuke) section of the Examples document for a practical example.
169+See the [%public-keys and %nuke](/docs/arvo/jael/examples#public-keys-and-nuke) section of the Examples document for a practical example.
170170
171171## `%rekey`
172172
@@ -190,7 +190,7 @@ Jael does not return any `gift` in response to a `%rekey` `task`.
190190
191191View domains.
192192
193−The domains returned by a `%turf` `task` are used as the base for individual galaxy domain names (e.g. from `urbit.org` you get `zod.urbit.org`, `bus.urbit.org`, etc). Jael gets these from Azimuth, then Ames gets them from Jael and passes them to the runtime, which will perform the DNS lookups and give Ames back the galaxy IP addresses. A `%turf` task takes no additional arguments. You're unlikely to use this manually - if you want the current `turf`s you'd likely want to do a [turf scry](@/docs/arvo/jael/scry.md#turf) instead.
193+The domains returned by a `%turf` `task` are used as the base for individual galaxy domain names (e.g. from `urbit.org` you get `zod.urbit.org`, `bus.urbit.org`, etc). Jael gets these from Azimuth, then Ames gets them from Jael and passes them to the runtime, which will perform the DNS lookups and give Ames back the galaxy IP addresses. A `%turf` task takes no additional arguments. You're unlikely to use this manually - if you want the current `turf`s you'd likely want to do a [turf scry](/docs/arvo/jael/scry#turf) instead.
194194
195195### Returns
196196
@@ -204,7 +204,7 @@ The `turf` in the `(list turf)` is a domain as a `(list @t)`, TLD-first. The cur
204204
205205### Example
206206
207−See the [%turf section of the Examples document](@/docs/arvo/jael/examples.md#turf) for a practical example.
207+See the [%turf section of the Examples document](/docs/arvo/jael/examples#turf) for a practical example.
208208
209209## `%step`
210210
@@ -222,4 +222,4 @@ Jael does not return a `gift` in response to a `%step` `task`.
222222
223223### Example
224224
225−See the [%step](@/docs/arvo/jael/examples.md#step) section of the Examples document for a practical example.
225+See the [%step](/docs/arvo/jael/examples#step) section of the Examples document for a practical example.