git.iko.soy/urbit.org
on master help sign in
fix links, various copy tweaks
7a571b2Josh Lehman
_index.md+9−4
compare with master
unifiedsplit
@@ -1,13 +1,18 @@
1+++
1+++
2−title = "Docs"
2+title = "Development Docs"
3weight = 1
3weight = 1
4template = "sections/docs.html"
4template = "sections/docs.html"
5+++
5+++
6
6
7+Welcome to the developer documentation for the Urbit project. This documentation
8+is maintained by [Tlon](https://tlon.io) and the Urbit community in a public
7−Welcome to the documentation for the Urbit project. This documentation is maintained by [Tlon](https://tlon.io) in a public [Github repository](https://github.com/urbit/docs). Issues and contributions are welcome.
9+[Github repository](https://github.com/urbit/docs). Issues and contributions are
8−
10+welcome.
9−If you already know what you're looking for, the easiest way to find it is with the search box located on the left.
10
11
12+This documentation provides a series of explainers, guides, tutorials and
13+reference material for assisting you in developing on the Urbit platform, or
14+contributing to the Urbit project. If you're looking for documentation on how to
15+*use* your Urbit ship, see our [usage docs](@/using/_index.md).
11
16
12### [Development](@/docs/development/_index.md)
17### [Development](@/docs/development/_index.md)
13
18
azimuth/azimuth.md+1−1
@@ -6,7 +6,7 @@ aliases = ["/docs/learn/azimuth"]
6+++
6+++
7Azimuth is a general-purpose public-key infrastructure (PKI) on the Ethereum blockchain, used as a platform for _Urbit identities_. You need such an identity to use the Arvo network.
7Azimuth is a general-purpose public-key infrastructure (PKI) on the Ethereum blockchain, used as a platform for _Urbit identities_. You need such an identity to use the Arvo network.
8
8
9−The primary way to interact with Azimuth is through our [Bridge](https://github.com/urbit/bridge) application and the node libraries that it depends on, [azimuth-js](https://github.com/urbit/azimuth-js) and [urbit-key-generation](https://github.com/urbit/urbit-key-generation). Take a look at the source and play around, or see [Getting Started](@/using/install.md).
9+The primary way to interact with Azimuth is through our [Bridge](https://github.com/urbit/bridge) application and the node libraries that it depends on, [azimuth-js](https://github.com/urbit/azimuth-js) and [urbit-key-generation](https://github.com/urbit/urbit-key-generation). Take a look at the source and play around, or see [Getting Started](@/getting-started.md).
10
10
11## Arvo vs. Azimuth
11## Arvo vs. Azimuth
12
12
development/develop.md+1−1
@@ -29,7 +29,7 @@ throughout the docs.
29
29
30Urbit ships with [Landscape](@/docs/landscape/overview.md), which can be thought
30Urbit ships with [Landscape](@/docs/landscape/overview.md), which can be thought
31of as its flagship client. Landscape can be broken into two different technical
31of as its flagship client. Landscape can be broken into two different technical
32−components: there's the collection of [services](#services) that utilize the
32+components: there's the collection of [agents](#agents) that utilize the
33Urbit for networking and data persistence, and the JavaScript client, which is
33Urbit for networking and data persistence, and the JavaScript client, which is
34an [interface](https://github.com/urbit/urbit/tree/master/pkg/interface) built
34an [interface](https://github.com/urbit/urbit/tree/master/pkg/interface) built
35with [React](https://reactjs.org).
35with [React](https://reactjs.org).
development/environment.md+1−1
@@ -14,7 +14,7 @@ To do work with Hoon, we recommended using a "fake" ship -- one that's not
14connected to the network.
14connected to the network.
15
15
16Because such a ship has no presence on the network, you don't need an Azimuth
16Because such a ship has no presence on the network, you don't need an Azimuth
17−identity. You just need to have [installed the Urbit binary](/using/install).
17+identity. You just need to have [installed the Urbit binary](/getting-started).
18
18
19To create a fake ship named `~zod`, run the command below. You can replace `zod`
19To create a fake ship named `~zod`, run the command below. You can replace `zod`
20with any valid Urbit ship-name.
20with any valid Urbit ship-name.
glossary/azimuth.md+1−1
@@ -14,5 +14,5 @@ It should be noted that Azimuth isn't built just for Arvo. It can be used as an
14### Further Reading
14### Further Reading
15
15
16- [The Azimuth concepts page](@/docs/azimuth/advanced-azimuth-tools.md): A more in-depth explanation of Azimuth, including information the storage of Urbit identities.
16- [The Azimuth concepts page](@/docs/azimuth/advanced-azimuth-tools.md): A more in-depth explanation of Azimuth, including information the storage of Urbit identities.
17−- [Install instructions](@/using/install.md): Guide to installing Urbit, which includes instructions on booting with your Urbit identity.
17+- [Install instructions](@/getting-started.md): Guide to installing Urbit, which includes instructions on booting with your Urbit identity.
18- [Understanding Urbit ID](@/understanding-urbit/urbit-id.md)
18- [Understanding Urbit ID](@/understanding-urbit/urbit-id.md)
glossary/comet.md+1−1
@@ -12,4 +12,4 @@ Comets have no presence on [Azimuth](../azimuth) and thus have no associated Urb
12
12
13### Further reading
13### Further reading
14
14
15−- [Creating a Comet](@/using/install.md#comet): A guide to spinning up a comet of your own.
15+- [Creating a Comet](@/getting-started.md#comet): A guide to spinning up a comet of your own.
glossary/dojo.md−1
@@ -11,5 +11,4 @@ The other default command-line app is [Chat](../chat). To switch between Dojo
11and [Chat](../chat) press Ctrl-X. The Dojo is the first thing you encounter after successfully booting your [ship](../ship).
11and [Chat](../chat) press Ctrl-X. The Dojo is the first thing you encounter after successfully booting your [ship](../ship).
12
12
13### Further Reading
13### Further Reading
14−- [Using Your Ship](@/using/os/using-your-ship.md): The "Shell" section contains instructions on using the Dojo.
15- [Hoon Tutorial Lesson 1.1: Setup](@/docs/hoon/hoon-school/setup.md): A great way to get started with using Hoon in the Dojo.
14- [Hoon Tutorial Lesson 1.1: Setup](@/docs/hoon/hoon-school/setup.md): A great way to get started with using Hoon in the Dojo.
glossary/keyfile.md+1−1
@@ -12,4 +12,4 @@ The keyfile is used as an argument in the command line when booting a ship. Duri
12
12
13### Further Reading
13### Further Reading
14
14
15−- [Installation Guide](@/using/install.md): Instructions on using a keyfile to boot a ship.
15+- [Installation Guide](@/getting-started.md): Instructions on using a keyfile to boot a ship.
glossary/moon.md+1−1
@@ -12,4 +12,4 @@ Unlike planets, moons have no presence on [Azimuth](../azimuth) and have no asso
12
12
13### Further Reading
13### Further Reading
14
14
15−- [Using Your Ship](@/using/os/using-your-ship.md#moons): The "Moons" section contains instructions for creating and managing moons.
15+- [Using Your Ship](@/using/os/getting-started.md#moons): The "Moons" section contains instructions for creating and managing moons.
glossary/ship.md+1−1
@@ -20,7 +20,7 @@ To be able to use the Arvo network, planets, stars, and galaxies must be combine
20
20
21### Further Reading
21### Further Reading
22
22
23−- [Using Bridge](@/using/install.md): A guide to installing Urbit and booting a ship.
23+- [Using Bridge](@/getting-started.md): A guide to installing Urbit and booting a ship.
24- [Ship Troubleshooting](@/using/os/ship-troubleshooting.md): General instructions on getting your ship to work, which includes network connectivity issues.
24- [Ship Troubleshooting](@/using/os/ship-troubleshooting.md): General instructions on getting your ship to work, which includes network connectivity issues.
25- [Understanding Urbit ID](@/understanding-urbit/urbit-id.md)
25- [Understanding Urbit ID](@/understanding-urbit/urbit-id.md)
26- [Pier](../pier): The directory containing a ship's state.
26- [Pier](../pier): The directory containing a ship's state.
hoon/hoon-school/setup.md+3−3
@@ -15,9 +15,9 @@ These may not look like numbers, but they are. Each urbit name is written in a b
15
15
16## Installing Urbit
16## Installing Urbit
17
17
18−You can install Urbit on any Mac or Unix machine; if you're just trying out Urbit or creating a development ship, you can follow the steps for creating a development ship [here](@/using/develop.md#creating-a-development-ship). On Windows, make a virtual Linux machine using VirtualBox or a similar tool.
18+You can install Urbit on any Mac or Unix machine; if you're just trying out Urbit or creating a development ship, you can follow the steps for creating a development ship [here](@/docs/development/environment.md). On Windows, make a virtual Linux machine using VirtualBox or a similar tool.
19
19
20−Once you're finished, you can [boot your very own ship](@/using/install.md#comet). While you can develop in Hoon on your own ship on the live network, we strongly suggest developing on a development ship first.
20+Once you're finished, you can [boot your very own ship](@/getting-started.md#comet). While you can develop in Hoon on your own ship on the live network, we strongly suggest developing on a development ship first.
21
21
22## Getting started
22## Getting started
23
23
@@ -67,7 +67,7 @@ You asked Dojo to evaluate `17` and it echoed the number back at you. This value
67
67
68Generators are the most straightforward way to write Hoon programs. They are a concept in Arvo, and involve saving Hoon code in a `.hoon` text file. While they aren't strictly part of the Hoon language, we'll be dealing with generators throughout this tutorial.
68Generators are the most straightforward way to write Hoon programs. They are a concept in Arvo, and involve saving Hoon code in a `.hoon` text file. While they aren't strictly part of the Hoon language, we'll be dealing with generators throughout this tutorial.
69
69
70−The simplest type of generator is the **naked generator**. All naked generators are `gates`: functions that take an argument and produce an output. Before creating a generator you need to [mount](@/using/install.md#the-dojo) your `desk` to Unix. To create a generator, all you need to do is write a `gate` and put it into a file in the `/home/gen/` directory of your ship as a `.hoon` file. (Assuming you've already mounted with `|mount /=home=`.) After this, you need to run `|commit %home` in Dojo and the new file will be recognized by your ship. To run a generator named `mygen.hoon`, you would type `+mygen <argument>` in your ship's Dojo.
70+The simplest type of generator is the **naked generator**. All naked generators are `gates`: functions that take an argument and produce an output. Before creating a generator you need to [mount](@/getting-started.md#the-dojo) your `desk` to Unix. To create a generator, all you need to do is write a `gate` and put it into a file in the `/home/gen/` directory of your ship as a `.hoon` file. (Assuming you've already mounted with `|mount /=home=`.) After this, you need to run `|commit %home` in Dojo and the new file will be recognized by your ship. To run a generator named `mygen.hoon`, you would type `+mygen <argument>` in your ship's Dojo.
71
71
72If this doesn't make sense yet, that's okay. In the [next lesson](@/docs/hoon/hoon-school/list-of-numbers.md), we will walk you through an example `gate` that is run as a generator.
72If this doesn't make sense yet, that's okay. In the [next lesson](@/docs/hoon/hoon-school/list-of-numbers.md), we will walk you through an example `gate` that is run as a generator.
73
73