git.iko.soy/urbit.org
on master help sign in
a preen
commitd452c09bd7b09dac21fb8f1f048e1a275559610c authorGalen Wolfe-Pauly <root@office-for.com> dateTue 5 Apr 2016, 18:56 (11 years ago) parent140ac0e
7 files changed+23−32
compare with master
unifiedsplit
docs.md+1−10 docs/programming.md+3−5 docs/using.md+1−1 docs/using/filesystem.md+3−3 docs/using/messaging.md+11−7 docs/using/shell.md+2−4 docs/using/web.md+2−2
docs.md+1−10
@@ -3,20 +3,11 @@ anchor: none
33footer: true
44---
55
6−Welcome to the Urbit documentation, served from Urbit. (If you
7−create an urbit, you can make a tree site like this one; just
8−copy a tree of Markdown files into a mounted `/===/web` node.)
9−
10−To understand what Urbit is, what it's designed to do, and what
11−it's made of, look into the [About](About) node. To install and
12−use Urbit, see [Using](Using). To learn how to program in Urbit,
13−see [Programming](Programming).
14−
156<div class="lead">
167 <div class="logo inverse"></div>
178 <h1 class="blue i-b">Urbit docs</h1>
189</div>
1910
20−<div class="sections lead-offset">
11+<div class="sections">
2112 <kids grid="true"></kids>
2213</div>
docs/programming.md+3−5
@@ -1,9 +1,7 @@
11---
2−sort: 1
2+sort: 3
33---
44
5−# About
5+# Programming
66
7−To learn about the
8−
9−<list dataPath="docs/about"></list>
7+<list dataPath="docs/programming"></list>
docs/using.md+1−1
@@ -1,5 +1,5 @@
11---
2−sort: 1
2+sort: 2
33---
44
55# Using
docs/using/filesystem.md+3−3
@@ -1,14 +1,14 @@
11---
22next: true
3−sort: 7
3+sort: 6
44title: Filesystem
55---
66
7+# Filesystem (`%clay`)
8+
79<div class="row">
810<div class="col-md-8">
911
10−# `%clay` (Filesystem)
11−
1212Urbit has its own revision-controlled filesystem, `%clay`. `%clay` is a typed, global, referentially transparent namespace. An easy way to think about it is like typed `git` with continuous sync.
1313
1414The most common way to use `%clay` is to mount a `%clay` node in
docs/using/messaging.md+11−7
@@ -1,28 +1,28 @@
11---
22next: true
33sort: 4
4−title: Messaging (`:talk`)
4+title: Messaging (:talk)
55---
66
7−# `:talk` (messaging)
7+# Messaging (`:talk`)
88
99<div class="row">
1010<div class="col-md-8">
1111
12−`:talk` is the Urbit messaging and notifications protocol. Today we use `:talk` to chat and coordinate. Come join us in `/urbit-meta` by using the [quickstart](#-quickstart) below.
12+`:talk` is the Urbit messaging and notifications protocol. Today we use `:talk` just to chat and coordinate, but it's really a general purpose piece of infrastructure.
1313
14−Today chat is sort of like a distributed, encrypted Slack that can be used from the CLI and the browser. There’s no central `:talk` server. Any Urbit can host one.
14+For the time being come join us in `/urbit-meta` by using the <a href="#-quickstart">quickstart</a> below.
1515
16−`:talk` is a general purpose tool for both aggregating and publishing streams of messages. Applications can use `:talk` as their transport protcol, API connectors can push disparate data sources into `:talk`, and so on. There are lots of things a distributed message protocol can be used for that we haven't even thought of.
16+Today `:talk` is sort of like a distributed, encrypted Slack that can be used from the CLI and the browser. There’s no central `:talk` server. Any Urbit can host one.
1717
18−There are two ways of using `:talk`: from the CLI or through a web ui available at `http://your-urbit.urbit.org/talk` (or `http://localhost:8080/talk`). The web ui ships as compiled JavaScript on your Urbit, but has its own source repo [here](https://github.com/urbit/talk).
18+`:talk` is a general purpose tool for both aggregating and publishing streams of messages. Applications can use `:talk` as their transport protcol, API connectors can push disparate data sources into `:talk`, and so on. There are lots of things a distributed message protocol can be used for that we haven't even thought of.
1919
2020</div>
2121</div>
2222
2323## Quickstart
2424
25−For the most part we use `:talk` as a single-instance of Slack. There's one main station and for sending direct messages to one another. Everyone is more than welcome in `/urbit-meta`. It's the place to get help, ask questions and chat about Urbit in general.
25+For the most part we use `:talk` as a single-instance of Slack: one main channel (`/urbit-meta`) and dms. Everyone is more than welcome in `/urbit-meta`. It's the place to get help, ask questions and chat about Urbit in general.
2626
2727Let's join `/urbit-meta`:
2828
@@ -59,6 +59,10 @@ To set your audience back to `/urbit-meta`:
5959
6060 ~your-urbit:talk> ;~doznec/urbit-meta
6161
62+There are two ways of using `:talk`: from the CLI or through a web ui available at `http://your-urbit.urbit.org/talk` (or `http://localhost:8080/talk`).
63+
64+The web ui ships as compiled JavaScript on your Urbit, but has its own source repo [here](https://github.com/urbit/talk).
65+
6266## Manual
6367
6468`:talk`s design is similar in spirit to [nntp](https://en.wikipedia.org/wiki/Network_News_Transfer_Protocol) the underlying protocol for Usenet.
docs/using/shell.md+2−4
@@ -4,13 +4,11 @@ sort: 5
44title: Shell (:dojo)
55---
66
7+# Shell (`:dojo`)
8+
79<div class="row">
810<div class="col-md-8">
911
10−
11−
12−## `:dojo` (shell)
13−
1412The `:dojo` is the place to quickly experiment with Urbit. At first glance the `:dojo` is just a Hoon REPL. Looking a bit deeper the `:dojo` is set up to make operating on and transforming data in Urbit easy.
1513
1614</div>
docs/using/web.md+2−2
@@ -1,6 +1,6 @@
11---
22next: true
3−sort: 6
3+sort: 7
44title: Web
55---
66
@@ -20,7 +20,7 @@ We ship `tree` as compiled JavaScript on your Urbit, but the source lives in its
2020
2121## Quickstart
2222
23−Your Urbit runs a web server and can be found at either `http://localhost:8080/` (or `8081` if you're running other processes that might be occupying `8080`, you can determine which port your urbit is on by looking at your boot sequence--it's specified there), or `http://your-urbit.urbit.org/`.
23+Your Urbit runs a web server and can be found at either `http://localhost:8080/` (or `8081` if you're running other processes that might be occupying `8080`, you can determine which port your urbit is on by looking at your boot sequence — it's specified there), or `http://your-urbit.urbit.org/`.
2424
2525(Make sure you have a desk mounted to unix, as covered in the [filesystem walkthrough](/filesystem))
2626