on master help sign in
Merge pull request #55 from urbit/introduction

adds introduction material

commit9de0ea16bbe467bea066d99e3078e48d259fd191 authorMorgan Sutherland <msutherl@users.noreply.github.com> dateFri 22 Mar 2019, 10:58 (8 years ago) parent298373917e6f15
1 file changed+66−9
static-site/docs.udon+66−9
static-site/docs.udon+66−9
@@ -1,13 +1,70 @@
1−:- :~ navhome/'/docs/'
2− navuptwo/'true'
3− next/'true'
4− sort/'1'
5− title/'Technical overview'
6− ==
7−;>
1+1 :- :~ navhome/'/docs/'
2+2 navuptwo/'true'
3+3 next/'true'
4+4 sort/'1'
5+5 title/'Introduction'
6+6 ==
7+7 ;>
88
99# Docs
1010
11−Welcome 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.
11+Welcome 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.
1212
13−Please make your way to the [Introduction](docs/introduction) for an overview of the docs.
13+The documentation is organized into five high-level sections. Read on to get acquainted.
14+
15+## [Getting Started](/docs/getting-started)
16+
17+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)!
18+
19+The three pages below are meant to be followed in order.
20+
21+- The [Bridge section](/docs/getting-started/azimuth) is the first step. It tells you how to access your Azimuth identity using our client.
22+- The [guide to installing Urbit](/docs/getting-started/installing-urbit) is the second step. It tells you how to get our software on your machine.
23+- The [guide to booting a ship](/docs/getting-started/booting-a-ship) is the third and final step. It walks you through using what you did in the previous steps to get onto the Arvo network.
24+
25+In addition to those primary pages, the documents below are helpful but optional for using Urbit.
26+
27+- [Creating a Development Ship](/docs/getting-started/creating-a-development-ship), a walkthrough for creating a walkthrough for creating a disposable ship, disconnected from the Arvo network, for hacking on Urbit, developing applications, and learning.
28+- [Operating a Star](/docs/getting-started/creating-a-development-ship)
29+
30+## [Using](/docs/using)
31+
32+Here live guides that are helpful for everyday users.
33+
34+- [Admin and Operation](/using/admin) is a guide to the basic commands used to interact with your ship.
35+- [Messaging](/using/messaging) tells you how to use Talk, our chat system.
36+- [Shell](/using/shell) is a guide to using Dojo, our command-line interface.
37+- [Introduction to the Filesystem](/using/filesystem) explains the basics of using use Clay, our revision-control filesystem.
38+- [Source Layout](/using/layout) walks you through the various directories of the Arvo operating system.
39+- [Sail](/using/sail) is a guide to Sail: Hoon markup that's used to build web pages with XML.
40+- [Udon](/using/udon) is a guide to Udon, which is our take on Markdown.
41+- [Generators](/using/generators) will explain how to use the "generator," a kind of file that's the easiest way to run Hoon programs.
42+
43+## [Concepts](/docs/concepts)
44+
45+If you're looking for a high-level introduction to the Urbit project and its components, start here.
46+
47+- [Arvo vs. Azimuth](/docs/concepts/arvo-vs-azimuth), a quick explanation of the two parallel systems that compose Urbit.
48+- [Technical Overview](/docs/concepts/technical-overview), a more in-depth description of the entire Urbit stack.
49+- [Contributing](/docs/concepts/contributing), a guide to getting involved with the Urbit project.
50+- [Community Tutorials](/docs/concepts/community-tutorials), a collection of unofficial but useful Urbit learning resources.
51+- [Source Code](/docs/concepts/source-code-overview), an explanation of Urbit's constituent GitHub repositories.
52+- [Galaxies, Stars, and Planets](/docs/concepts/galaxies-stars-and-planets), an explanation of the Azimuth address-space hierarchy.
53+
54+## [Learn](/docs/learn)
55+
56+If you're interested in contributing to the project, building applications, or understanding the system technically, take a look at our tutorials and explanations of Urbit's components.
57+
58+- The [Hoon section](/docs/learn/hoon), for resources on learning our programming language. To understand the system, start here.
59+- The [Arvo section](/docs/learn/arvo), for the internals of Arvo, Urbit's operating system.
60+- The [Nock section](/docs/learn/nock), for learning Nock, Urbit's low-level language.
61+- The [Vere section](/docs/learn/vere), for learning about Vere, the virtual machine that runs on Unix.
62+
63+## [Reference](/docs/reference)
64+
65+If you're a developer looking for Arvo reference documentation, this section is for you.
66+
67+- The [Glossary](/docs/reference/glossary) will help if you're confused by all the new jargon.
68+- The [Cheat Sheet](/docs/reference/cheat-sheet) is a compact document for looking up Hoon expressions.
69+- The [Hoon Expressions](/docs/reference/hoon-expressions) section contains more comprehensive reference material for Hoon expressions.
70+- The [Standard Library](/docs/reference/library) section documents the Hoon standard library.