@@ -1,6 +1,6 @@
1# Urbit docs
1# Urbit docs
3−These are the urbit docs as they appear on [urbit.org](urbit.org/docs).
3+These are the urbit docs as they appear on [urbit.org](urbit.org/docs/).
5We've found it helps to have a clone of the docs on hand in case urbit.org
5We've found it helps to have a clone of the docs on hand in case urbit.org
6experiences high traffic. Follow these steps to get these into your ship:
6experiences high traffic. Follow these steps to get these into your ship:
@@ -8,18 +8,18 @@ experiences high traffic. Follow these steps to get these into your ship:
8## Installation
8## Installation
10First, you'll need a running urbit. Follow our urbit.org [install
10First, you'll need a running urbit. Follow our urbit.org [install
11−instructions](https://urbit.org/docs/using/install), then
11+instructions](https://urbit.org/docs/using/install/), then
12−[setup](https://urbit.org/docs/using/setup) an urbit.
12+[setup](https://urbit.org/docs/using/setup/) an urbit.
14Follow the *Network install* below if your urbit is running on the live network
14Follow the *Network install* below if your urbit is running on the live network
15(comets are usually best for development). Follow the *Local install* instead if
15(comets are usually best for development). Follow the *Local install* instead if
16you're on a [fake
16you're on a [fake
17−ship](https://urbit.org/fora/posts/~2017.1.5..21.31.04..20f3~/) or are otherwise
17+ship](https://fora.urbit.org/general/posts/~2017.1.5..21.31.04..20f3~/) or are otherwise
18experiencing problems with the network install.
18experiencing problems with the network install.
20### Network install
20### Network install
22−In your urbit's `:dojo`, run the command:
22+In your urbit's Dojo, run the command:
24 ~your-urbit:dojo> |sync %home ~nosnup-nomzod %docs
24 ~your-urbit:dojo> |sync %home ~nosnup-nomzod %docs
@@ -30,28 +30,28 @@ output:
30 sync succeeded from %docs on ~nosnup-nomzod to %home
30 sync succeeded from %docs on ~nosnup-nomzod to %home
32If your sync isn't succeeding after a few minutes for whatever reason, run
32If your sync isn't succeeding after a few minutes for whatever reason, run
33−`|cancel %home` in your `:dojo` and follow the local install below instead.
33+`|cancel %home` in your Dojo and follow the local install below instead.
35### Local install
35### Local install
37−In your urbit's `:dojo`:
37+In your urbit's Dojo:
39 ~your-urbit:dojo> |mount /=home=
39 ~your-urbit:dojo> |mount /=home=
41−If `~your-urbit` was installed at `/urbit/path` on your Unix machine, you can
42−now find your home desk at the path `/urbit/path/your-urbit/home`.
41+You can now find your home desk at the path `/path/to/your-urbit/home/`.
44In Unix, clone this repo somewhere and copy in the `docs` files to your urbit's
43In Unix, clone this repo somewhere and copy in the `docs` files to your urbit's
45mounted `%home` desk. You can run the following shell commands (*replacing your
44mounted `%home` desk. You can run the following shell commands (*replacing your
46urbit's home desk path as necessary*):
45urbit's home desk path as necessary*):
48− $ git clone https://github.com/urbit/docs
47+ $ git clone https://github.com/urbit/docs.git
49− $ cp -r ./docs* /urbit/path/your-urbit/home/web
49+ $ cp -r ./docs* /path/to/your-urbit/home/web/
51−Your `%clay` filesystem should acknowledge the newly added files.
51+Your Clay filesystem should acknowledge the newly added files.
53−Lastly, serve your home desk's `web` directory to the web by running the
53+Lastly, if make sure you're serving your home desk's `web` directory to the web
54−following `:dojo` command:
54+by running the following Dojo command:
56 ~your-urbit:dojo> |serve /=home=/web
56 ~your-urbit:dojo> |serve /=home=/web
@@ -59,23 +59,24 @@ following `:dojo` command:
60And now your docs are live! View them at:
60And now your docs are live! View them at:
62− http://localhost:8443/~~/docs
62+ http://localhost:8080/~~/docs
64−> If you're running multiple ships locally, your port number will be `8444`,
64+> If you're running multiple ships locally, your port number will be `8081`,
65−> `8445`, and so on. Check your `:dojo` output for the correct local port of
65+> `8082`, and so on. Check your Dojo output for the correct local port of
66> your examples urbit, or view these at `https://your-urbit.urbit.org` over DNS
66> your examples urbit, or view these at `https://your-urbit.urbit.org` over DNS
67−> instead for live-network ships.
67+> instead for live-network ships. You can also replace `localhost` with the IP
68+> of your instance, if you're running your urbit in the cloud.
69## Learn a lot, and have fun!
70## Learn a lot, and have fun!
71People are always around on
72People are always around on
72−[`:talk`](https://urbit.org/docs/using/setup#-messaging-talk) and
73+[Talk](https://urbit.org/docs/using/setup#-messaging-talk) and
73−[`:fora`](https://urbit.org/~~/fora) to answer your questions. Help each other
74+[Fora](https://fora.urbit.org/) to answer your questions. Help each other
74out, and don't hesitate if you have an idea for a docs improvement. We'd love if
75out, and don't hesitate if you have an idea for a docs improvement. We'd love if
75the docs themselves became an Urbit community project.
76the docs themselves became an Urbit community project.
77## Contributing / Feedback
78## Contributing / Feedback
79−Give us feedback [on `:fora`](https://urbit.org/~~/fora/) on how we can make the
80+Give us feedback [on Fora](https://fora.urbit.org/) on how we can make the
80docs better. Let us know about your ideas, requests, and/or problems and we'll
81docs better. Let us know about your ideas, requests, and/or problems and we'll
81try and get back to you quickly. Pull requests are more than welcome.
82try and get back to you quickly. Pull requests are more than welcome.