git.iko.soy/urbit.org
on master help sign in
fix links, various copy tweaks
commit7a571b29292213d84f9c9aaa3048ac249565b5fd authorJosh Lehman <josh@starcity.com> dateFri 12 Mar 2021, 10:32 (6 years ago) parentd7f7e13
11 files changed+20−16
compare with master
unifiedsplit
_index.md+9−4 azimuth/azimuth.md+1−1 development/develop.md+1−1 development/environment.md+1−1 glossary/azimuth.md+1−1 glossary/comet.md+1−1 glossary/dojo.md−1 glossary/keyfile.md+1−1 glossary/moon.md+1−1 glossary/ship.md+1−1 hoon/hoon-school/setup.md+3−3
_index.md+9−4
@@ -1,13 +1,18 @@
11+++
2−title = "Docs"
2+title = "Development Docs"
33weight = 1
44template = "sections/docs.html"
55+++
66
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.
8−
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.
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
9+[Github repository](https://github.com/urbit/docs). Issues and contributions are
10+welcome.
1011
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).
1116
1217### [Development](@/docs/development/_index.md)
1318
azimuth/azimuth.md+1−1
@@ -6,7 +6,7 @@ aliases = ["/docs/learn/azimuth"]
66+++
77Azimuth 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.
88
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).
1010
1111## Arvo vs. Azimuth
1212
development/develop.md+1−1
@@ -29,7 +29,7 @@ throughout the docs.
2929
3030Urbit ships with [Landscape](@/docs/landscape/overview.md), which can be thought
3131of 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
3333Urbit for networking and data persistence, and the JavaScript client, which is
3434an [interface](https://github.com/urbit/urbit/tree/master/pkg/interface) built
3535with [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
1414connected to the network.
1515
1616Because 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).
1818
1919To create a fake ship named `~zod`, run the command below. You can replace `zod`
2020with 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
1414### Further Reading
1515
1616- [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.
1818- [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
1212
1313### Further reading
1414
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
1111and [Chat](../chat) press Ctrl-X. The Dojo is the first thing you encounter after successfully booting your [ship](../ship).
1212
1313### Further Reading
14−- [Using Your Ship](@/using/os/using-your-ship.md): The "Shell" section contains instructions on using the Dojo.
1514- [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
1212
1313### Further Reading
1414
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
1212
1313### Further Reading
1414
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
2020
2121### Further Reading
2222
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.
2424- [Ship Troubleshooting](@/using/os/ship-troubleshooting.md): General instructions on getting your ship to work, which includes network connectivity issues.
2525- [Understanding Urbit ID](@/understanding-urbit/urbit-id.md)
2626- [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
1515
1616## Installing Urbit
1717
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.
1919
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.
2121
2222## Getting started
2323
@@ -67,7 +67,7 @@ You asked Dojo to evaluate `17` and it echoed the number back at you. This value
6767
6868Generators 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.
6969
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.
7171
7272If 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.
7373