b5c2047 · urbit.org · git.iko.soy

concepts/source-code-overview.md+2−2

@@ -13,9 +13,9 @@ important ones here:

13

14This is the main Urbit repo. It contains the Urbit interpreter (all of the C code) and is the main entry point if you're going to build from source.

15

16−## [`urbit/arvo`](https://github.com/urbit/arvo)

16+It also contains Arvo, the Urbit operating system (written in Hoon), as a subtree. When you boot your Urbit, you get this over the air. The source code is kept here, and you'll need it if you want to do any heavy development work.

17

18−Arvo is the Urbit operating system (written in Hoon). When you boot your Urbit, you get this over the air. The source code is kept here, and you'll need it if you want to do any heavy development work.

18+## [`urbit/docs`](https://github.com/urbit/docs)

19

20Interesting in working on Urbit documentation? This repository is where all the collaboration happens. The docs themselves are just markdown files hosted on a live ship.

21

getting-started/contributing.md+1−1

@@ -18,4 +18,4 @@ If you're just getting set up to work on the Urbit or Arvo code base for the fir

18

19## Code style

20

21−Before contributing Hoon code, you should familiarize yourself with the [Hoon style guide](@/docs/learn/hoon/style.md). For a good example of idiomatic Hoon, see [Ford](https://github.com/urbit/arvo/blob/master/sys/vane/ford.hoon).

21+Before contributing Hoon code, you should familiarize yourself with the [Hoon style guide](@/docs/learn/hoon/style.md). For a good example of idiomatic Hoon, see [Ford](https://github.com/urbit/urbit/blob/master/pkg/arvo/sys/vane/ford.hoon).

learn/arvo/gall.md+1−1

@@ -1711,7 +1711,7 @@ identity), and `eny` (512 bits of guaranteed-fresh entropy). For the full list

1711of things in `++bowl`, search for `++ bowl` (note: two spaces) in

1712`/arvo/zuse.hoon`.

1713

1714−> This is, perhaps, the most common way to learn Hoon. The easiest way to learn about an identifier you see in code is to search in `/arvo/zuse.hoon` and `/arvo/hoon.hoon` for it.\\ Urbit's codebase is less than 30000 lines of code combined, including the hoon parser, the compiler, and the `/arvo` microkernel, so you can usually use the code and its comments as a reference doc. You can also read [zuse.hoon](https://github.com/urbit/arvo/blob/master/arvo/zuse.hoon) and [hoon.hoon](https://github.com/urbit/arvo/blob/master/arvo/hoon.hoon) in your browser.

1714+> This is, perhaps, the most common way to learn Hoon. The easiest way to learn about an identifier you see in code is to search in `/arvo/sys/zuse.hoon` and `/arvo/sys/hoon.hoon` for it.\\ Urbit's codebase is less than 30000 lines of code combined, including the hoon parser, the compiler, and the `/arvo` microkernel, so you can usually use the code and its comments as a reference doc. You can also read [zuse.hoon](https://github.com/urbit/urbit/blob/master/pkg/arvo/sys/zuse.hoon) and [hoon.hoon](https://github.com/urbit/urbit/blob/master/pkg/arvo/sys/hoon.hoon) in your browser.

1715

1716The second thing we should clear up is this: Urbit needs no "serialize to disk"

1717step. Everything you produce in the app state is persistent across calls to the

learn/arvo/hall.md+3−3

@@ -495,10 +495,10 @@ And, of course, there's a lot that the Talk client can improve on as well.

495## Further reading

496

497To gain a more thorough understanding of Hall's inner workings, take a look at its source code. It comes with inline documentation.

498−[On Github.](https://github.com/urbit/arvo/blob/master/app/hall.hoon)

498+[On Github.](https://github.com/urbit/urbit/blob/master/pkg/arvo/app/hall.hoon)

499

500To see an expansive example of a Hall client, take a look at the code of Talk. It, too, comes with inline documentation.

501−[On Github.](https://github.com/urbit/arvo/blob/master/app/talk.hoon)

501+[On Github.](https://github.com/urbit/urbit/blob/master/pkg/arvo/app/talk.hoon)

502

503# The Hall Interface

504

@@ -864,7 +864,7 @@ When the user makes any changes to shared UI elements (elements that should pers

864

865# The New Gall Model

866

867−This document is complemented by the source code of applications that use the new Gall model (like [Hall](https://github.com/urbit/arvo/blob/master/app/hall.hoon)), but doesn't require it. Code snippets will be provided where useful. Some knowledge of Hoon and the functioning of Hoon apps is assumed.

867+This document is complemented by the source code of applications that use the new Gall model (like [Hall](https://github.com/urbit/urbit/blob/master/pkg/arvo/app/hall.hoon)), but doesn't require it. Code snippets will be provided where useful. Some knowledge of Hoon and the functioning of Hoon apps is assumed.

868

869New `%gall` has not yet fully solidified. As such, its structure and naming are tentative.

870

learn/hoon/hoon-tutorial/doors.md+1−1

@@ -194,7 +194,7 @@ Let's look once more at the parent core of the `add` arm in the Hoon standard li

194<74.dbd 1.qct $141>

195```

196

197−The battery of this core contains 74 arms, each of which evaluates to a gate in the standard library. This 'library' is nothing more than a core containing useful basic functions that Hoon often makes available as part of the subject. You can see the Hoon code defining these arms near the beginning of [hoon.hoon](https://github.com/urbit/arvo/blob/master/sys/hoon.hoon), starting with [`++ add`](https://github.com/urbit/arvo/blob/master/sys/hoon.hoon#L21). (Yes, the Hoon standard library is written in Hoon.)

197+The battery of this core contains 74 arms, each of which evaluates to a gate in the standard library. This 'library' is nothing more than a core containing useful basic functions that Hoon often makes available as part of the subject. You can see the Hoon code defining these arms near the beginning of [hoon.hoon](https://github.com/urbit/urbit/blob/master/pkg/arvo/sys/hoon.hoon), starting with [`++ add`](https://github.com/urbit/urbit/blob/master/pkg/arvo/sys/hoon.hoon#L21). (Yes, the Hoon standard library is written in Hoon.)

198

199Here are some of the other gates that can be generated from this core in the Hoon standard library. It should be fairly obvious what they do:

200