@@ -1,14 +1,81 @@
1−Urbit docs
1+# Urbit docs
4−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).
6−If you'd like to serve the contents from your Urbit just copy `docs/` and `docs.md` into `web/` inside your urbit.
5+We've found it helps to have a clone of the docs on hand in case urbit.org
6+experiences high traffic. Follow these steps to get these into your ship:
9−Contributing
10+First, you'll need a running urbit. Follow our urbit.org [install
10−============
11+instructions](https://urbit.org/docs/using/install), then
12+[setup](https://urbit.org/docs/using/setup) an urbit.
12−PRs are more than welcome: both corrections and suggestions.
14+Follow 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
17+ship](https://urbit.org/fora/posts/~2017.1.5..21.31.04..20f3~/) or are otherwise
18+experiencing problems with the network install.
14−We're almost always available on `:talk`, but you can also email [`urbit@urbit.org`](mailto:urbit@urbit.org) or post to [`urbit-dev`](https://groups.google.com/forum/#!forum/urbit-dev) if you have questions.
20+### Network install
22+In your urbit's `:dojo`, run the command:
24+ ~your-urbit:dojo> |sync %home ~ropmev-pocseb %docs
26+Depending on network traffic, this initial merge and sync could take anywhere
27+between thirty seconds to several minutes. Upon a successful sync you'll see the
30+ sync succeeded from %docs on ~ropmev-pocseb to %home
32+If 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.
37+In your urbit's `:dojo`:
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`.
44+In Unix, clone this repo somewhere and copy in the `docs` files to your urbit's
45+mounted `%home` desk. You can run the following shell commands (*replacing your
46+urbit's home desk path as necessary*):
48+ $ git clone https://github.com/urbit/docs
49+ $ cp -r ./docs* /urbit/path/your-urbit/home/web
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
54+following `:dojo` command:
56+ ~your-urbit:dojo> |serve /=home=/web
60+And now your docs are live! View them at:
62+ http://localhost:8443/~~/docs
64+> If you're running multiple ships locally, your port number will be `8444`,
65+> `8445`, 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
67+> instead for live-network ships.
69+## Learn a lot, and have fun!
71+People are always around on
72+[`:talk`](https://urbit.org/docs/using/setup#-messaging-talk) and
73+[`:fora`](https://urbit.org/~~/fora) to answer your questions. Help each other
74+out, and don't hesitate if you have an idea for a docs improvement. We'd love if
75+the docs themselves became an Urbit community project.
77+## Contributing / Feedback
79+Give us feedback [on `:fora`](https://urbit.org/~~/fora/) on how we can make the
80+docs better. Let us know about your ideas, requests, and/or problems and we'll
81+try and get back to you quickly. Pull requests are more than welcome.