d452c09 · urbit.org · git.iko.soy

docs.md+1−10

compare with master

unifiedsplit

@@ -3,20 +3,11 @@ anchor: none

3footer: true

4---

5

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−

15<div class="lead">

6<div class="lead">

16 <div class="logo inverse"></div>

7 <div class="logo inverse"></div>

17 <h1 class="blue i-b">Urbit docs</h1>

8 <h1 class="blue i-b">Urbit docs</h1>

18</div>

9</div>

19

10

20−<div class="sections lead-offset">

11+<div class="sections">

21 <kids grid="true"></kids>

12 <kids grid="true"></kids>

22</div>

13</div>

docs/programming.md+3−5

@@ -1,9 +1,7 @@

1---

2−sort: 1

2+sort: 3

3---

4

5−# About

5+# Programming

6

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 @@

1---

2−sort: 1

2+sort: 2

3---

4

5# Using

docs/using/filesystem.md+3−3

@@ -1,14 +1,14 @@

1---

2next: true

3−sort: 7

3+sort: 6

4title: Filesystem

5---

6

7+# Filesystem (`%clay`)

8+

7<div class="row">

9<div class="row">

8<div class="col-md-8">

10<div class="col-md-8">

9

11

10−# `%clay` (Filesystem)

11−

12Urbit 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.

13

14The most common way to use `%clay` is to mount a `%clay` node in

docs/using/messaging.md+11−7

@@ -1,28 +1,28 @@

1---

2next: true

3sort: 4

4−title: Messaging (`:talk`)

4+title: Messaging (:talk)

5---

6

7−# `:talk` (messaging)

7+# Messaging (`:talk`)

8

9<div class="row">

10<div class="col-md-8">

11

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.

13

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.

15

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.

17

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.

19

20</div>

21</div>

22

23## Quickstart

24

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.

26

27Let's join `/urbit-meta`:

28

@@ -59,6 +59,10 @@ To set your audience back to `/urbit-meta`:

59

60 ~your-urbit:talk> ;~doznec/urbit-meta

61

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+

62## Manual

66## Manual

63

67

64`:talk`s design is similar in spirit to [nntp](https://en.wikipedia.org/wiki/Network_News_Transfer_Protocol) the underlying protocol for Usenet.

68`: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

4title: Shell (:dojo)

5---

6

7+# Shell (`:dojo`)

8+

7<div class="row">

9<div class="row">

8<div class="col-md-8">

10<div class="col-md-8">

9

11

10−

11−

12−## `:dojo` (shell)

13−

14The `: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.

12The `: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.

15

13

16</div>

14</div>

docs/using/web.md+2−2

@@ -1,6 +1,6 @@

1---

2next: true

3−sort: 6

3+sort: 7

4title: Web

5---

6

@@ -20,7 +20,7 @@ We ship `tree` as compiled JavaScript on your Urbit, but the source lives in its

20

21## Quickstart

22

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/`.

24

25(Make sure you have a desk mounted to unix, as covered in the [filesystem walkthrough](/filesystem))

26