d98f9b4 · urbit.org · git.iko.soy

git.iko.soy/urbit.org

fixes broken links

commitd98f9b47eae7fb6dffac1b2b69cf312aeaa7a56e authorRobert <robert@tlon.io> dateTue 22 Jan 2019, 13:36 (8 years ago) parenteebbba0

21 files changed+52−46

compare with master

unifiedsplit

getting-started.udon+13

@@ -349,6 +349,19 @@ urbit -F zod

349349If you want to get on the Arvo network with your point, then continue to the

350350next section.

351351

352+;=

353+ ;h3

354+ ;div(id "swap"): Set Up Swap

355+ ==

356+==

357+

358+If you're running Urbit in the cloud on a small instance, you may need to additionally configure swap space. If you're not, skip this section.

359+

360+Urbit wants to map 2GB of memory when it boots up. We won’t necessarily use all this memory, we just want to see it. On a normal modern PC or Mac, or on a large cloud virtual machine, this is not an issue. On some small cloud virtual machines (Amazon or Digital Ocean), the default memory configuration is smaller than this, and you need to manually configure a swapfile.

361+

362+Digital Ocean has a post on adding swap [here](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-16-04). For Amazon there’s a StackOverflow thread [here](https://stackoverflow.com/questions/17173972/how-do-you-add-swap-to-an-ec2-instance).

363+

364+Don’t spend a lot of time tweaking these settings; the simplest thing is fine.

352365

353366;=

354367 ;h2

introduction.udon+3−3

@@ -17,12 +17,12 @@ If you're looking for a high-level introduction to the Urbit project and its com

1717- [Arvo vs. Azimuth](/docs/introduction/arvo-vs-azimuth), a quick explanation of the two parallel systems that compose Urbit.

1818- [Technical Overview](/docs/introduction/technical-overview), a more in-depth description of the entire Urbit stack.

1919- [Contributing](/docs/introduction/contributing), a guide to getting involved with the Urbit project.

20−- [Community Tutorials](/docs/introduction/community), a collection of unofficial but useful Urbit learning resources.

21−- [Source Code](/docs/introduction/source), an explanation of Urbit's constituent GitHub repos.

20+- [Community Tutorials](/docs/introduction/community-tutorials), a collection of unofficial but useful Urbit learning resources.

21+- [Source Code](/docs/introduction/source-code-overview), an explanation of Urbit's constituent GitHub repos.

2222

2323## [Getting Started](/docs/getting-started)

2424

25−If you'd like to install Arvo, get an Azimuth point, and/or get on the Urbit network, you'll find guides here. Dive in, and don't be afraid to [ask for help](support@urbit.org)!

25+If you'd like to install Arvo, get an Azimuth point, and/or get on the Urbit network, you'll find guides here. Dive in, and don't be afraid to [ask for help](mailto:support@urbit.org)!

2626

2727- [The Installation Guide](/docs/getting-started), a step-by-step walkthrough for getting Urbit running.

2828- [The Azimuth section](/docs/getting-started/azimuth), which contains information on managing your Azimuth identities.

introduction/community-tutorials.udon+2−4

@@ -5,16 +5,14 @@

55 ==

66;>

8−# Community Docs

8+# Community Docs

1010Here are some tutorials written by members of the Urbit community. Some are a little outdated, but they may still prove useful.

1111

1212If you want to add something to this list, [shoot us an email](mailto:support@urbit.org).

1313

1414- `~master-morzod`

15− - [Fora post](https://urbit.org/fora/posts/~2016.12.25..06.35.44..a1ec~/)

16−- `~hidduc-posmeg`

17− - [Fora post](https://urbit.org/fora/posts/~2017.2.12..21.54.40..6fde~/)

15+ - [Fora post](https://github.com/joemfb/mardev/tree/master/docs/gen)

1816- `~palfun-foslup`

1917 - [Urbit by Doing](https://github.com/Fang-/Urbit-By-Doing)

2018- `@knubie`

learn/arvo/arvo-internals/admin.udon+2−2

@@ -143,7 +143,7 @@ To generate a random moon from your planet, run:

143143```

144144

145145You can use the resulting output in the same installation flow from

146−[install](/../install) and [setup](/../setup), following the same scheme as

146+[install](../install) and [setup](../setup), following the same scheme as

147147for booting a planet. That scheme is:

148148

149149```

@@ -162,7 +162,7 @@ $ urbit -w faswep-navred-sampel-palnet -t habref-mebsem-parsym-batlus -c mymoon

162162

163163Moons are automatically synced to their parent `%kids` desk, and can control

164164applications on their parent planet using `|link`. You can read more about

165−those operations in the [filesystem](/../filesystem) and [console](/../shell)

165+those operations in the [filesystem](../filesystem) and [console](../shell)

166166walkthroughs, respectively.

167167

168168

learn/arvo/arvo-internals/ford.udon+2−2

@@ -127,7 +127,7 @@ library in urbit.

127127

128128To run this example, put this code in your desk at `gen/faslus.hoon` and run

129129`+faslus` in your dojo. This example is a generator. For more information on

130−generators, see the [generator docs](https://urbit.org/docs/arvo/generators).

130+generators, see the [generator docs](/docs/arvo/arvo-internals/generators).

131131

132132```

133133/+ time-to-id

@@ -281,7 +281,7 @@ produces the text of the hoon file at "/path/to/hoon-file/hoon".

281281passes the contents through unchanged. In general, rendering a file with a

282282mark will potentially run the contents through a series of conversion

283283operations. For details on marks, see the

284−[marks docs](https://urbit.org/docs/arvo/marks).

284+[Gall docs](../gall).

285285

286286Here's an example that includes a mark conversion:

287287```

learn/arvo/arvo-internals/gall.udon+4−6

@@ -535,7 +535,7 @@ when you run a command like `+ls` or `|merge`, there are no marks in

535535sight.

536536

537537We've used generators before, back in [Basic

538−Operation](/docs/using/admin). At that point, we just used the

538+Operation](/docs/learn/arvo/arvo-internals/admin). At that point, we just used the

539539generators to produce values -- we didn't pipe their results into apps.

540540In the dojo cast, the role of a generator is to take a list of arguments

541541and produce a value, which is often, though not always, piped into an

@@ -576,10 +576,8 @@ pattern is so common, this can be abbreviated to

576576generators for the `:hood` app, `:hood|generator <args>` can be

577577shortened to `|generator <args>`.

578578

579−Let's write a generator for a modified version of `:pong` from

580−the chapter on [Network Messages](/docs/arvo/system/network). Recall

581−that `:pong` takes an urbit address, which is of mark `urbit`,

582−and sends that urbit the message `'howdy'`. First--without a

579+Let's write a generator called `:pong` that takes an urbit address, which is of

580+mark `urbit`, and sends that urbit the message `'howdy'`. First--without a

583581generator--let's make `:ping` that does the same, except that

584582it lets the user optionally specify the message as well.

585583

@@ -785,7 +783,7 @@ purl:eyre)`. Thus, the result is null if and only if the url is malformed.

785783When you send this request, you can expect a `%sigh` with the

786784response, which we handle later on in `++sigh-httr`.

787785

788−For `%wait`, you just pass a [`@da`]() (absolute date), and arvo will

786+For `%wait`, you just pass a `@da` (absolute date), and arvo will

789787produce a `%wake` when the time comes.

790788

791789> A timer is guaranteed to not be triggered before the given time, but it's currently impossible to guarantee the timer will be triggered at exactly the requested time.

learn/arvo/arvo-internals/generators.udon+1−1

@@ -29,7 +29,7 @@ a

2929

3030This generator takes one argument of any noun and produces it without any

3131changes. If we put this into a file named `echo.hoon` in the `/gen` directory,

32−we can run it from the [Dojo](/docs/using/shell):

32+we can run it from the [Dojo](/docs/learn/arvo/arvo-internals/shell):

3333

3434```

3535> +echo 42

learn/arvo/arvo-internals/layout.udon+4−4

@@ -47,7 +47,7 @@ This is where the Arvo kernel lives. `sys/` contains:

4747

4848##### `sys/hoon.hoon`

4949

50−[Hoon](../../tutorials/hoon-ch1) is our programming language. Since Hoon

50+[Hoon](/docs/learn/arvo/hoon) is our programming language. Since Hoon

5151compiles itself, the language is actually specified in this source file.

5252

5353##### `sys/zuse.hoon`

@@ -104,9 +104,9 @@ That's it. That's the whole system.

104104

105105## app/

106106

107−This is where [Gall](../../tutorials/gall) apps live. Gall apps are stateful

107+This is where [Gall](../gall) apps live. Gall apps are stateful

108108servers, sort of like unix daemons. One familiar one is `app/hall.hoon` which is

109−the source code for [Hall](../../tutorials/hall), the Urbit messaging transport

109+the source code for [Hall](../hall), the Urbit messaging transport

110110layer. And there's also `app/dojo.hoon` — that's your shell.

111111

112112---

@@ -167,7 +167,7 @@ lib/test/*

167167## web/

168168

169169Here are files publicly accessible to the web, as made possible by

170−[Eyre](../web).

170+[Eyre](../eyre).

171171

172172---

173173

learn/arvo/arvo-internals/messaging.udon+1−1

@@ -27,7 +27,7 @@ be used for that we haven't even thought of.

2727

2828Here we'll be discussing how to operate the default CLI frontend, Talk,

2929to send and receive messages. For a more in-depth look at Hall's internals,

30−take a look at its [documentation](../../tutorials/hall).

30+take a look at its [documentation](../hall).

3131

3232## Quickstart

3333

learn/arvo/arvo-internals/publishing.udon+2−2

@@ -43,7 +43,7 @@ Your urbit's web server can be accessed remotely at

4343way, one that is generated by running the `+code` command in the Dojo.

4444

4545_(Make sure you have a desk mounted to unix, as covered in the

46−[setup section](/../../using/setup))._

46+[setup section](../filesystem/))._

4747

4848##### Serving

4949

@@ -95,7 +95,7 @@ Let's continue our with our `test.udon` example. Create `/sandbox/web/test/` and

9595add two more Udon files in `/sandbox/web/test/daughter.udon`

9696`/sandbox/web/test/son.udon`, respectively. Make sure that they contain valid

9797Udon. Udon is our markup language, similar to Markdown; check out the guide

98−[here](../../tutorials/).

98+[here](../udon/).

9999

100100> NOTE: Due to a bug in Urbit, you may have to create the directory and the file

101101 in it in rapid succession using something like `mkdir sandbox/web/test && touch

learn/arvo/arvo-internals/sail.udon+2−2

@@ -497,8 +497,8 @@ see what its value is.

497497

498498The first line, `=+ wid=(met 3 p.bem.gas)`, combines a new noun with the

499499subject and gives it the face `wid`. This noun is produced by the the

500−standard-library function [`met`](../reference/library/2c), which measures the number of

501−[blocks](../reference/library/1c/) of size `a` within `b`. Blocks are units that have a

500+standard-library function [`met`](/docs/reference/library/2c), which measures the number of

501+[blocks](/docs/reference/library/1c/) of size `a` within `b`. Blocks are units that have a

502502bitwidth of `2^a`. So, in this case, it measures how many bytes (blocks of size

5035033 are bitwidths of 8; `2^3 = 8`) are fully contained in your ship's address.

504504

learn/arvo/arvo-internals/shell.udon+3−3

@@ -37,7 +37,7 @@ Tall-form Hoon may require multiple lines:

3737~your-urbit:dojo< 2

3838```

3939

40−Hoon uses something called [the subject](../../tutorials/hoon-ch1/hoon-ch1-3).

40+Hoon uses something called [the subject](/docs/learn/arvo/hoon/the-subject-and-its-legs).

4141The Dojo has its own subject, and that's where Hoon's equivalent of variables,

4242called faces, are stored.

4343

@@ -59,7 +59,7 @@ Use `=dir` to set the current working directory:

5959```

6060

6161(`%` represents your current directory. For a complete explanation on urbit

62−paths, see the [filesystem section](/docs/using/filesystem))

62+paths, see the [filesystem section](../filesystem))

6363

6464Generators (files in `/gen`) are run with `+`:

6565

@@ -264,7 +264,7 @@ Apps usually expect marked data, so `&` is often used here.

264264

265265##### `*` - Save in `%clay`

266266

267−Save a new `.udon` ([Udon](/docs/tutorials/udon)) file in `web`:

267+Save a new `.udon` ([Udon](../udon)) file in `web`:

268268

269269```

270270~your-urbit:dojo> *%/web/foo/udon '# hello'

learn/arvo/vere/jetting.udon+1−1

@@ -502,7 +502,7 @@ First, you may need to massage your inputs a bit to get them into types that you

502502

503503You have received a bunch of `u3_nouns` or `u3_atoms`, but you presumably want to do things in a native C / non-Hoon manner: computing w raw integers, etc.

504504

505−A `u3_noun` will want to be further diassembled into atoms.

505+A `u3_noun` will want to be further disassembled into atoms.

506506

507507A `u3_atom` represents a simple number, but the implementation may or

508508may not be simple. If the value held in the atom is 31 bits or less,

learn/azimuth/blockchain.udon+2−2

@@ -45,5 +45,5 @@ computation Landscape the latter is not. We need a computational blockchain to

4545enforce the specific rules of the Urbit identity registry.

4646

4747For more background on the decision to use the Ethereum blockchain, check out

48−[these](urbit.org/essays/urbit-and-the-blockchain)

49−[two](urbit.org/updates/2017.9.20-bootstrapping-urbit-from-ethereum) posts.

48+[these](urbit.org/posts/essays/urbit-and-the-blockchain)

49+[two](urbit.org/posts/updates/2017.9.20-bootstrapping-urbit-from-ethereum) posts.

reference/cheat-sheet.udon+1−1

@@ -20,7 +20,7 @@ hand. So above is a download link to a Hoon cheatsheet .pdf. It's missing a

2020few of the literal syntaxes, but it covers the most common ones.

2121

2222This doesn't list any of the Ford runes, although there is now at least

23−some documentation for those [here](../../tutorials/internals/ford/runes).

23+some documentation for those [here](/docs/learn/arvo/arvo-internals/ford#runes).

2424

2525The following runes also exist, but are currently undocumented and not listed in

2626the cheat sheet:

reference/glossary.udon+2−3

@@ -712,8 +712,7 @@ number of bits in their address:

712712Any ship can be called an _urbit_. The lowercase "u" distinguishes it from Urbit

713713the software stack and Urbit the network.

714714

715−_You can find a longer-form summary here:

716−[`urbit.org/posts/address-space/`](https://urbit.org/posts/address-space/)._

715+_You can find a longer-form summary [here.](https://urbit.org/posts/essays/the-urbit-address-space/)._

717716

718717An Urbit identity is a string like `~firbyr-napbes`. It means nothing,

719718but it's easy to remember and say out loud. `~firbyr-napbes` is actually

@@ -880,7 +879,7 @@ of the simpler built-in types.

880879 error. This is one of the most commons errors in Hoon programming.

881880

882881 _See [advanced types](/docs/reference/hoon-expressions/advanced/)_.

883− _See [troubleshooting](/docs/reference/hoon-expressions/troubleshooting)_.

882+ _See [troubleshooting](/docs/reference/troubleshooting)_.

884883

885884

886885### Unit

reference/hoon-expressions/irregular.udon−2

@@ -8,8 +8,6 @@

99##### `~palfun-foslup`

1010

11−*Original Fora post* [here](https://urbit.org/fora/posts/~2016.12.29..19.37.08..89d5~/).

12−

1311##### Reading guide

1412

1513Headings contain runes, phonetics and tokens. Description contains a link to the docs and a short description of the rune. Both regular (R) and irregular (I) forms are given.

reference/library/2e.udon+1−1

@@ -12,7 +12,7 @@

1212FNV scrambler

1313

1414Hashes an atom with the 32-bit FNV non-cryptographic hash algorithm. Multiplies

15−`a` by the prime number 16,777,619 and then takes the [block](../2c.md) of size

15+`a` by the prime number 16,777,619 and then takes the [block](../2c) of size

16165 off the product's end, producing an atom.

1717

1818#### Accepts

reference/library/2o.udon+1−1

@@ -81,7 +81,7 @@ Mold generator. A `jug` is a `map` of `set`.

8181

8282#### Discussion

8383

84−See also: [`ja`](../2j), [`by`](../2i), [`map`](../2i), [`set`](..2h)

84+See also: [`ja`](../2j), [`by`](../2i), [`set`](../2h)

8585

8686---

8787### `++map`

reference/library/3g.udon+4−4

@@ -55,9 +55,9 @@ and printed using `++so` and `++co` cores.

5555

5656Aura-atom pair

5757

58−Used in `++coin`. Convenience methods [`++scot`](../4m.md) and

59−[`++scow`](../4m.md) print dimes as `++cord` and `++tape`, respectively.

60−[`++slat`](../4m.md), [`++slav`](../4m.md), and [`++slaw`](../4m.md) are used

58+Used in `++coin`. Convenience methods [`++scot`](../4m) and

59+[`++scow`](../4m) print dimes as `++cord` and `++tape`, respectively.

60+[`++slat`](../4m), [`++slav`](../4m), and [`++slaw`](../4m) are used

6161to parse atoms of specific auras.

6262

6363#### Source

@@ -98,7 +98,7 @@ Optional result `p` and parsing continuation `q`.

9898

9999#### Discussion

100100

101−See also: [Section 2e](../2e.md), `++rule`

101+See also: [Section 2e](../2e), `++rule`

102102

103103

104104---

reference/troubleshooting.udon+1−1

@@ -132,7 +132,7 @@ function.

132132

133133These are errors caused by type inference in pattern matching.

134134`mint-vain` means this hoon is never executed. `mint-lost` means

135−there's a case in a `?-` ([*wuthep*](./docs/reference/hoon-expressions/rune/wut#wuthep)) that isn't handled.

135+there's a case in a `?-` ([*wuthep*](/docs/reference/hoon-expressions/rune/wut#wuthep)) that isn't handled.

136136

137137## Runtime crashes

138138