git.iko.soy/urbit.org
on master help sign in
Merge pull request #650 from urbit/top-page

adds context to the docs landing page

commit1623e1f2c41a09a84d2c5cc9ed2d8ee5ade3a1d6 authorrmariani <robert@tlon.io> dateWed 9 Oct 2019, 09:44 (7 years ago) parentf5a1840302f336
2 files changed+31−5
compare with master
unifiedsplit
_index.md+29−3 azimuth/azimuth.md+2−2
_index.md+29−3
@@ -4,6 +4,32 @@ template = "sections/docs.html"
44+++
55Welcome to the documentation for the Urbit project, including the Azimuth identity layer, the Arvo operating system, and the Hoon programming language. This documentation is maintained by [Tlon](https://tlon.io) in a public [Github repository](https://github.com/urbit/docs). Issues and contributions are welcome.
66
7−- [Install Urbit](/install)
8−- [Operator's Manual](/operations)
9−- [Developer's Guide](/develop)
7+## Getting Started
8+
9+The following three guides will help get you started on Urbit.
10+
11+### [Install Urbit](/install)
12+
13+Urbit isn't ready for serious use yet, but it's available to try out. If you have an Urbit identity, you can follow this step-by-step guide to get your point's _keyfile_, which you need to boot your ship. Then you can install Urbit and join the community.
14+
15+### [Operator's Manual](/operations)
16+
17+The Operator's Manual will show you how to perform everyday functions on your Urbit.
18+
19+### [Developer's Guide](/develop)
20+
21+This guide will teach you how set up an Urbit development environment.
22+
23+## Technical Documentation
24+
25+The documentation proper is contained on the sidebar of this page. It's meant for those interested in development on Urbit, and it's sorted by section:
26+
27+- [Arvo](../arvo) is the Urbit operating system. If you're interested in finding out about the architecture of the system, check out this section.
28+
29+- [Azimuth](../arvo) is the Urbit identity layer. To use Urbit, you need an identity that is secured by Azimuth.
30+
31+- [Hoon](../hoon) is the functional programming language used to build Urbit. This section contains tutorials that will help you build proficiency in the language.
32+
33+- [Nock](../nock) is the low-level language Hoon compiles to. If you want to understand that absolute fundamentals of Urbit, this section will be of help.
34+
35+- [Vere](../vere) is the Nock interpreter that acts as the layer between Urbit and whatever system (MacOS, Linux, BSD) is running it.
azimuth/azimuth.md+2−2
@@ -5,8 +5,8 @@ template = "doc.html"
55aliases = ["/docs/learn/azimuth"]
66+++
77
8−Azimuth is a general-purpose public-key infrastructure (PKI) on the Ethereum blockchain, used as a decentralized ledger for Urbit identities that we call **points**. Having a point is necessary to use the Urbit network, which makes it important to have a neutral ledger to determine who owns what.
8+Azimuth is a general-purpose public-key infrastructure (PKI) on the Ethereum blockchain, used as a decentralized ledger for Urbit identities that we call **Urbit identities**. Having an identity is necessary to use the Urbit network, which makes it important to have a neutral ledger to determine who owns what.
99
10−Azimuth is not, however, part of the Arvo stack. Azimuth is a parallel system that be used as a generalized identity system for other projects. Azimuth "touches" the Urbit ecosystem when a point is used to boot a virtual computer on the Urbit network for the first time. When that happens, the point considered **linked** to Azimuth and the point’s full powers are available for use. Once a point is linked, it cannot be unlinked.
10+Azimuth is not, however, part of the Arvo stack. Azimuth is a parallel system that be used as a generalized identity system for other projects. Azimuth "touches" the Urbit ecosystem when an identity is used to boot a virtual computer on the Urbit network for the first time. When that happens, the identity considered **linked** to Azimuth and the identity’s full powers are available for use. Once an identity is linked, it cannot be unlinked.
1111
1212A metaphor might make the relationship between these two systems easier to understand: Azimuth is the bank vault that stores the deed to your house. The Urbit network is the neighborhood that you live in.