git.iko.soy/urbit.org
on master help sign in
Update Using docs
cc551c1Keaton Dunsford
docs/using.md+1
compare with master
unifiedsplit
@@ -1,6 +1,7 @@
1---
1---
2navhome: /docs/
2navhome: /docs/
3sort: 1
3sort: 1
4+title: Using
4---
5---
5
6
6# Get Started
7# Get Started
docs/using/admin.md+8−19
@@ -1,11 +1,12 @@
1---
1---
2navhome: /docs/
2navhome: /docs/
3+navuptwo: true
3next: true
4next: true
4−sort: 3
5+sort: 4
5−title: Administration and Operation
6+title: Administration and operation
6---
7---
7
8
8−# Administration
9+# Administration and operation
9
10
10<div class="row">
11<div class="row">
11<div class="col-md-8">
12<div class="col-md-8">
@@ -17,7 +18,7 @@ Your Urbit is a persistent Unix process that you mainly control from the console
17
18
18## Shutdown
19## Shutdown
19
20
20−You can turn your Urbit off with `ctrl-d` from the `:talk` or `:dojo` prompts.
21+You can turn your Urbit off with `ctrl-d` from the Talk or Dojo prompts.
21
22
22## Restart
23## Restart
23
24
@@ -50,13 +51,13 @@ To move a pier, simply move the contents of the directory it lives in. To keep
50
51
51Your Urbit terminal is separated into two parts: the prompt (the bottom line) and the record (everything above that). The record is shared; all the output from all the apps in your command set appears in it. The prompt is multiplexed.
52Your Urbit terminal is separated into two parts: the prompt (the bottom line) and the record (everything above that). The record is shared; all the output from all the apps in your command set appears in it. The prompt is multiplexed.
52
53
53−In the CLI Urbit apps can process your input before you hit return. To see this in action try entering `)` as the first character at the `:dojo` prompt. Since there is no dojo command or hoon expression that starts with ')', the dojo rejects it.
54+In the CLI Urbit apps can process your input before you hit return. To see this in action try entering `)` as the first character at the Dojo prompt. Since there is no dojo command or hoon expression that starts with ')', the dojo rejects it.
54
55
55`ctrl-x` - Switches the prompt between running console apps
56`ctrl-x` - Switches the prompt between running console apps
56
57
57`ctrl-c` - Crash current event. Processed at the Unix layer and prints a stack trace.
58`ctrl-c` - Crash current event. Processed at the Unix layer and prints a stack trace.
58
59
59−`ctrl-d` - From `:talk` or `:dojo` stops your Urbit process.
60+`ctrl-d` - From Talk or Dojo stops your Urbit process.
60
61
61`↑` / `↓` - History navigation
62`↑` / `↓` - History navigation
62
63
@@ -76,7 +77,7 @@ The following emacs-style key bindings are available:
76 ctrl-u kill to beginning of line
77 ctrl-u kill to beginning of line
77 ctrl-y yank from kill buffer
78 ctrl-y yank from kill buffer
78
79
79−Full coverage of the Urbit shell, the `:dojo` is covered in the [Shell walkthrough](/docs/using/shell).
80+Full coverage of the Urbit shell, the Dojo is covered in the [Shell walkthrough](/docs/using/shell).
80
81
81## Web
82## Web
82
83
@@ -87,18 +88,6 @@ Your Urbit serves a simple homepage from `http://localhost:8080` or `https://you
87
88
88A complete walkthrough of the Urbit web interface is [here](/docs/using/web).
89A complete walkthrough of the Urbit web interface is [here](/docs/using/web).
89
90
90−## Moons
91−
92−Urbit namespace is distributed by having parent nodes sign the keys for child nodes. If you have a planet, your parent star issued your ticket. As a planet you, in turn, can sign the keys for moons. The basic idea is: your planet runs permanently in a data center somewhere and moons run on all your devices. Each planet can issue ~4 billion (`2^32`) moons.
93−
94−To generate a random moon from your planet run:
95−
96− ~your-urbit:dojo> +moon
97−
98−You can use the resulting output in the same installation flow from [install](/docs/using/install).
99−
100−Moons are automatically synced to their parent `%kids` desk, and can control applications on their parent planet using `|link`. You can read more about those things in the [filesystem](/docs/using/filesystem) and [console](/docs/using/shell) walkthroughs.
101−
102## Continuity breaches
91## Continuity breaches
103
92
104While the Urbit network is in this alpha state we sometimes have to reboot the whole network. This happens either when major changes need to be shipped or we hit a bug that can't be fixed over the air.
93While the Urbit network is in this alpha state we sometimes have to reboot the whole network. This happens either when major changes need to be shipped or we hit a bug that can't be fixed over the air.
docs/using/filesystem.md+11−10
@@ -1,21 +1,22 @@
1---
1---
2−navhome: '/docs'
2+navhome: /docs/
3+navuptwo: true
3−next: True
4+next: true
4−sort: 6
5+sort: 7
5−title: Filesystem
6+title: Filesystem (Clay)
6---
7---
7
8
8−# Filesystem (`%clay`)
9+# Filesystem (Clay)
9
10
10<div class="row">
11<div class="row">
11
12
12<div class="col-md-8">
13<div class="col-md-8">
13
14
14−Urbit has its own revision-controlled filesystem, `%clay`. `%clay` is a
15+Urbit has its own revision-controlled filesystem, Clay. Clay is a
15typed, global, referentially transparent namespace. An easy way to think
16typed, global, referentially transparent namespace. An easy way to think
16about it is like typed `git` with continuous sync.
17about it is like typed `git` with continuous sync.
17
18
18−The most common way to use `%clay` is to mount a `%clay` node in a Unix
19+The most common way to use Clay is to mount a Clay node in a Unix
19directory. The Urbit process will watch this directory and automatically
20directory. The Urbit process will watch this directory and automatically
20record edits as changes, Dropbox style. The mounted directory is always
21record edits as changes, Dropbox style. The mounted directory is always
21at the root of your pier directory.
22at the root of your pier directory.
@@ -32,7 +33,7 @@ Create a `%sandbox` desk based on the `%home` desk:
32
33
33 |merge %sandbox ~your-urbit %home
34 |merge %sandbox ~your-urbit %home
34
35
35−Most of the time we want to use `%clay` from Unix.
36+Most of the time we want to use Clay from Unix.
36
37
37Mount the entire contents of your `sandbox` desk to Unix:
38Mount the entire contents of your `sandbox` desk to Unix:
38
39
@@ -57,7 +58,7 @@ Sync from your friend `~some-ship`'s `%experiment` desk to your
57Paths
58Paths
58</h3>
59</h3>
59
60
60−A path in `%clay` is a list of URL-safe text, restricted to
61+A path in Clay is a list of URL-safe text, restricted to
61`[a z]`,`[0 9]`, `.`, `-`, `_` and `~`. Formally this is a `(list knot)`
62`[a z]`,`[0 9]`, `.`, `-`, `_` and `~`. Formally this is a `(list knot)`
62where each segment is a `@ta`.
63where each segment is a `@ta`.
63
64
@@ -228,7 +229,7 @@ Copy the file at `from` into the path `to`.
228
229
229Move the file at `from` into the path `to`.
230Move the file at `from` into the path `to`.
230
231
231−In `%clay`, `|mv` is just a shorthand for `|cp` then `|rm`. The `|rm`
232+In Clay, `|mv` is just a shorthand for `|cp` then `|rm`. The `|rm`
232doesn't happen unless the `|cp` succeeds.
233doesn't happen unless the `|cp` succeeds.
233
234
234### Generators
235### Generators
docs/using/install.md+15−1
@@ -77,12 +77,26 @@ Which can usually be installed with the following one-liners:
77
77
78### Clone and make
78### Clone and make
79
79
80−Once your dependencies are installed the rest is easy:
80+Once your dependencies are installed the rest is easy.
81+
82+If you're cloning the `urbit/urbit` Git repository for the first time, run:
81
83
82 $ git clone https://github.com/urbit/urbit
84 $ git clone https://github.com/urbit/urbit
83 $ cd urbit
85 $ cd urbit
84 $ make # gmake on FreeBSD
86 $ make # gmake on FreeBSD
85
87
88+_**Updated for the `2017.12.7` continuity breach**_
89+
90+If you already have a clone of the `urbit/urbit` Git repository, assuming
91+your `origin` upstream is the `urbit/urbit` repository on Github, run the
92+following commands to make sure you're on the correct, clean Git branch:
93+
94+ $ cd urbit
95+ $ git fetch --all
96+ $ git checkout master
97+ $ git reset --hard origin/master
98+ $ make # gmake on FreeBSD
99+
86After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
100After running `make`, your Urbit executable is in `bin/urbit`. Install it wherever you'd like.
87
101
88 # sudo install -m 0755 bin/urbit /usr/local/bin
102 # sudo install -m 0755 bin/urbit /usr/local/bin
docs/using/layout.md+20−19
@@ -1,6 +1,8 @@
1---
1---
2navhome: /docs/
2navhome: /docs/
3+navuptwo: true
4+next: true
3−sort: 9
5+sort: 3
4title: Source layout
6title: Source layout
5---
7---
6
8
@@ -29,63 +31,63 @@ Looking at the top level of [the Arvo repo](http://github.com/urbit/arvo), or an
29
31
30Let's step through directory by directory.
32Let's step through directory by directory.
31
33
32−## `app/`
34+## `app/`
33
35
34−This is where `%gall` apps live. `%gall` apps are stateful servers, sort of like unix daemons. One familiar one is `app/talk.hoon` which is the source code for `:talk` the urbit messaging transport layer. And there's also `app/dojo.hoon` — that's your shell.
36+This is where Gall apps live. Gall apps are stateful servers, sort of like unix daemons. One familiar one is `app/talk.hoon` which is the source code for Talk the urbit messaging transport layer. And there's also `app/dojo.hoon` — that's your shell.
35
37
36## `arvo/`
38## `arvo/`
37
39
38−This is where the `%arvo` vanes live. Vanes are sort of like kernel modules. These are worth listing one by one:
40+This is where the Arvo vanes live. Vanes are sort of like kernel modules. These are worth listing one by one:
39
41
40### `arvo/ames.hoon`
42### `arvo/ames.hoon`
41
43
42−`%ames` is our network protocol.
44+Ames is our network protocol.
43
45
44### `arvo/behn.hoon`
46### `arvo/behn.hoon`
45
47
46−`%behn` is a simple timer.
48+Behn is a simple timer.
47
49
48### `arvo/clay.hoon`
50### `arvo/clay.hoon`
49
51
50−`%clay` is our filesystem.
52+Clay is our filesystem.
51
53
52### `arvo/dill.hoon`
54### `arvo/dill.hoon`
53
55
54−`%dill` is our terminal driver.
56+Dill is our terminal driver.
55
57
56### `arvo/eyre.hoon`
58### `arvo/eyre.hoon`
57
59
58−`%eyre` is our webserver.
60+Eyre is our webserver.
59
61
60### `arvo/ford.hoon`
62### `arvo/ford.hoon`
61
63
62−`%ford` is our build system.
64+Ford is our build system.
63
65
64### `arvo/gall.hoon`
66### `arvo/gall.hoon`
65
67
66−`%gall` is our application model.
68+Gall is our application model.
67
69
68### `arvo/hoon.hoon`
70### `arvo/hoon.hoon`
69
71
70−`%hoon` is our programming langauge. Since Hoon compiles itself the language is actually specified in this source file.
72+Hoon is our programming langauge. Since Hoon compiles itself the language is actually specified in this source file.
71
73
72### `arvo/zuse.hoon`
74### `arvo/zuse.hoon`
73
75
74−`%zuse` is the Hoon library.
76+Zuse is the Hoon library.
75
77
76−That's it. That's the whole system.
78+That's it. That's the whole system.
77
79
78## `gen/`
80## `gen/`
79
81
80−`gen/` holds generators. Generators are short `:dojo` scripts.
82+`gen/` holds generators. Generators are short Dojo scripts.
81
83
82## `lib/`
84## `lib/`
83
85
84−`lib/` holds shared libraries for programs. `lib/sole` is a good example — that's the console library that's shared by both `:dojo` in the command line, and the `dojo` web client.
86+`lib/` holds shared libraries for programs. `lib/sole` is a good example — that's the console library that's shared by both Dojo in the command line, and the Dojo web client.
85
87
86## `mar/`
88## `mar/`
87
89
88−This is where marks live. Marks are data type definitions used by `%ford`. A mark is like a mime-type, but specified in executable code.
90+This is where marks live. Marks are data type definitions used by Ford. A mark is like a mime-type, but specified in executable code.
89
91
90## `ren/`
92## `ren/`
91
93
@@ -99,9 +101,8 @@ Default web requests in urbit are handled as a `.urb`, which is caught by the `u
99
101
100## `web/`
102## `web/`
101
103
102−There are the files publicly accessible to the web, as made possible by `%eyre`.
104+There are the files publicly accessible to the web, as made possible by Eyre.
103
105
104## `web.md`
106## `web.md`
105
107
106This is the homepage for your urbit. You'll see it at `http://localhost:8080/` or `http://fintud-macrep.urbit.org/`.
108This is the homepage for your urbit. You'll see it at `http://localhost:8080/` or `http://fintud-macrep.urbit.org/`.
107−
docs/using/messaging.md+125−104
@@ -1,36 +1,37 @@
1---
1---
2−navhome: '/docs'
2+navhome: /docs/
3+navuptwo: true
3−next: True
4+next: true
4−sort: 4
5+sort: 5
5−title: Messaging (:talk)
6+title: Messaging (Talk and Hall)
6---
7---
7
8
8−# Messaging (`:talk`)
9+# Messaging (Talk and Hall)
9
10
10<div class="row">
11<div class="row">
11
12
12<div class="col-md-8">
13<div class="col-md-8">
13
14
14−`:talk` is the built-in frontend for the Urbit messaging and notifications
15+Talk is the built-in frontend for the Urbit messaging and notifications
15−protocol, `:hall`. Today we use `:hall` just to chat and coordinate, but
16+protocol, Hall. Today we use Hall to chat and coordinate, but it's really
16−it's really a general purpose piece of infrastructure.
17+a general purpose piece of infrastructure.
17
18
18For the time being come join us in `/urbit-meta` by using the
19For the time being come join us in `/urbit-meta` by using the
19<a href="#-quickstart">quickstart</a> below.
20<a href="#-quickstart">quickstart</a> below.
20
21
21−Today `:hall` is sort of like a distributed, encrypted Slack that can be
22+Today, Hall is sort of like a distributed, encrypted Slack that can be
22−used from the CLI and the browser. There’s no central `:hall` server.
23+used from the CLI and the browser. There’s no central Hall server.
23Any Urbit can host one.
24Any Urbit can host one.
24
25
25−`:hall` is a general purpose tool for both aggregating and publishing
26+Hall is a general purpose tool for both aggregating and publishing
26−streams of messages. Applications can use `:hall` as their transport
27+streams of messages. Applications can use Hall as their transport
27−protocol, API connectors can push disparate data sources into `:hall`,
28+protcol, API connectors can push disparate data sources into Hall,
28and so on. There are lots of things a distributed message protocol can
29and so on. There are lots of things a distributed message protocol can
29be used for that we haven't even thought of.
30be used for that we haven't even thought of.
30
31
31−Here we'll be discussing how to operate the default CLI frontend, `:talk`,
32+Here we'll be discussing how to operate the default CLI frontend, Talk,
32−to send and receive messages. For a more in-depth look at `:hall`'s
33+to send and receive messages. For a more in-depth look at Hall's internals,
33−internals, take a look at its [documentation](#TODO).
34+take a look at its [documentation](../../hall/architecture).
34
35
35</div>
36</div>
36
37
@@ -38,36 +39,39 @@ internals, take a look at its [documentation](#TODO).
38
39
39## Quickstart
40## Quickstart
40
41
41−For the most part we use `:talk` as a single-instance of Slack: one main
42+For the most part we use Talk as a single-instance of Slack: one main
42−channel (`/urbit-meta`) and direct messages. Everyone is more than welcome
43+channel (`/urbit-meta`) and direct messages. Everyone is more than welcome
43in `/urbit-meta`. It's the place to get help, ask questions and chat about
44in `/urbit-meta`. It's the place to get help, ask questions and chat about
44Urbit in general.
45Urbit in general.
45
46
46Let's join `/urbit-meta`:
47Let's join `/urbit-meta`:
47
48
48−Use `ctrl-x` to switch from `:dojo` to `:talk`.
49+Use `ctrl-x` to switch from Dojo to Talk.
49
50
50To join `/urbit-meta`:
51To join `/urbit-meta`:
51
52
52− ~your-urbit:talk[] ;join /urbit-meta
53+ ~your-urbit:talk> ;join /urbit-meta
53
54
54−You'll see:
55+You'll see something like:
55
56
56 --------------| ;join /urbit-meta
57 --------------| ;join /urbit-meta
57− --------------| new glyph '>'
58+ --------------| :: onn /urbit-meta
59+ --------------| bound '=' {[hos=~marzod nom=%urbit-meta]}
60+ --------------| new = /urbit-meta
61+ --------------| /urbit-meta: hey ~marzod hear
58− ~your-urbit:talk>
62+ ~your-urbit:talk-
59
63
60Post a line to `/urbit-meta`:
64Post a line to `/urbit-meta`:
61
65
62− ~your-urbit:talk> hello, world
66+ ~your-urbit:talk- Hello, world!
63
67
64You'll see, echoed back at you:
68You'll see, echoed back at you:
65
69
66− ~your-urbit> hello, world
70+ ~your-urbit- Hello, world!
67
71
68To send a direct message to someone, first set your audience:
72To send a direct message to someone, first set your audience:
69
73
70− ~your-urbit:talk> ;~talsur-todres
74+ ~your-urbit:talk- ;~talsur-todres
71
75
72You'll see your prompt change:
76You'll see your prompt change:
73
77
@@ -75,35 +79,48 @@ You'll see your prompt change:
75
79
76Now you and `~talsur-todres` can exchange messages directly.
80Now you and `~talsur-todres` can exchange messages directly.
77
81
82+ ~your-urbit:talk[~talsur-todres] Hey buddy!
83+
78To set your audience back to `/urbit-meta`:
84To set your audience back to `/urbit-meta`:
79
85
80− ~your-urbit:talk> ;/urbit-meta
86+ ~your-urbit:talk[~talsur-todres] ;/urbit-meta
87+
88+You'll see your prompt change back:
89+
90+ ~your-urbit:talk-
91+
92+You can also use the ASCII "glyph" assigned to your `/urbit-meta` circle as a shortcut:
93+
94+ ~your-urbit:talk[~talsur-todres] ;-
95+ ~your-urbit:talk-
96+
97+(Your ship may have a different glyph than `-` for your circle)
81
98
82Use `;leave` to unsubscribe from a channel:
99Use `;leave` to unsubscribe from a channel:
83
100
84− ~your-urbit:talk> ;leave /urbit-meta
101+ ~your-urbit:talk- ;leave /urbit-meta
85
102
86−There are two ways of using `:talk`: from the CLI or through a web ui
103+There are two ways of using Talk: from the CLI or through a web UI
87−available at `http://your-urbit.urbit.org/talk` (or
104+available at `http://your-urbit.urbit.org/~~/talk` (or
88−`http://localhost:8080/talk`).
105+`http://localhost:8080/~~/talk`).
89
106
90−The web ui ships as compiled JavaScript on your Urbit, but has its own
107+The web UI ships as compiled JavaScript on your Urbit, but has its own
91source repo [here](https://github.com/urbit/talk).
108source repo [here](https://github.com/urbit/talk).
92
109
93Last, let's create a channel we can invite some friends to:
110Last, let's create a channel we can invite some friends to:
94
111
95− ~your-urbit:talk> ;create channel %my-channel 'some description'
112+ ~your-urbit:talk> ;create channel %my-channel 'Some description.'
96
113
97Now you can tell your friends to `;join ~your-urbit/my-channel`.
114Now you can tell your friends to `;join ~your-urbit/my-channel`.
98
115
99## Manual
116## Manual
100
117
101−`:hall`'s design is similar in spirit to
118+Hall's design is similar in spirit to
102−[nntp](https://en.wikipedia.org/wiki/Network_News_Transfer_Protocol),
119+[NNTP](https://en.wikipedia.org/wiki/Network_News_Transfer_Protocol),
103the underlying protocol for Usenet.
120the underlying protocol for Usenet.
104
121
105−Our design is pretty simple: `:hall` messages go to ‘circles’. Any urbit
122+Our design is pretty simple: Hall messages are called _posts_. Posts
106−can host or subscribe to any number of circles.
123+go to _circles_. Any urbit can host or subscribe to any number of circles.
107
124
108There are four kinds of circles: a write-only `%mailbox` for direct
125There are four kinds of circles: a write-only `%mailbox` for direct
109messages, an invite-only `%village` for private conversation, a read-only
126messages, an invite-only `%village` for private conversation, a read-only
@@ -113,7 +130,7 @@ general use.
113### Posts
130### Posts
114
131
115A post can be a variety of different data structures. Let's look at the
132A post can be a variety of different data structures. Let's look at the
116−ones you can use from within `:talk`: lines, URLs, expressions and
133+ones you can use from within Talk: lines, URLs, Hoon and
117replies.
134replies.
118
135
119#### Lines
136#### Lines
@@ -121,31 +138,32 @@ replies.
121A line is simply a string of text. Depending on the filtering rules set
138A line is simply a string of text. Depending on the filtering rules set
122by the circle's host, these may or may not include uppercase and Unicode
139by the circle's host, these may or may not include uppercase and Unicode
123characters.
140characters.
141+
124If the line starts with `@`, it's an action (IRC `/me`).
142If the line starts with `@`, it's an action (IRC `/me`).
125
143
126− ~your-urbit:talk> @sends a message
144+ ~your-urbit:talk> @sends a message.
127
145
128will print as
146will print as
129
147
130− ~your-urbit sends a message
148+ ~your-urbit sends a message.
131
149
132#### URLs
150#### URLs
133
151
134A URL is any valid URL.
152A URL is any valid URL.
135
153
136− ~your-urbit:talk> http://example.com/
154+ ~your-urbit:talk> https://example.com/
137
155
138−### Expressions
156+### Hoon
139
157
140−Expressions can be used to show and evaluate Hoon code. Send an expression
158+You can use Talk to evaluate Hoon code and share the result with everyone in a
141−by prefacing your message with `#`.
159+Hall circle. To do so, preface your Hoon with `#`.
142
160
143− ~your-urbit:talk> #(add 1 2)
161+ ~your-urbit:talk- #(add 2 2)
144
162
145will print as
163will print as
146
164
147− ~your-urbit# (add 1 2)
165+ ~your-urbit# (add 2 2)
148− 3
166+ 4
149
167
150### Replies
168### Replies
151
169
@@ -153,12 +171,12 @@ To indicate what you're saying is in direct response to a specific
153message, select the message (see Activating Lines below) and type your
171message, select the message (see Activating Lines below) and type your
154response.
172response.
155
173
156− ~some-urbit> hello! how are you?
174+ ~some-urbit- Hello! How are you?
157− ~your-urbit:talk> ; good, thanks!
175+ ~your-urbit:talk> ; Good, thanks!
158
176
159will print as
177will print as
160
178
161− ~your-urbit>^ good, thanks!
179+ ~your-urbit>^ Good, thanks!
162
180
163### Activating Lines
181### Activating Lines
164
182
@@ -166,18 +184,18 @@ A line number identifying the *subsequent* line is displayed every 5
166lines.
184lines.
167
185
168 ---------[0]
186 ---------[0]
169− ~your-urbit> this is my message
187+ ~your-urbit- This is my message.
170− ~your-urbit> this is another message
188+ ~your-urbit- This is another message.
171− ~your-urbit sends a message
189+ ~your-urbit sends a message.
172 ~your-urbit/ http://example.com/
190 ~your-urbit/ http://example.com/
173− ~your-urbit# (add 1 2)
191+ ~your-urbit# (add 2 2)
174− 3
192+ 4
175 ---------[5]
193 ---------[5]
176− ~your-urbit>^ that's my message!
194+ ~your-urbit>^ That's my message!
177
195
178You can use a line number to *activate* a line:
196You can use a line number to *activate* a line:
179
197
180− ~your-urbit:talk> ;5
198+ ~your-urbit:talk- ;5
181
199
182which prints the number, line identifier, timestamp, sender, audience,
200which prints the number, line identifier, timestamp, sender, audience,
183and contents:
201and contents:
@@ -186,8 +204,8 @@ and contents:
186 0v3.hl51p.jhege.amhec.vb37r.3rejr at ~2016.6.24..04.48.21..a235
204 0v3.hl51p.jhege.amhec.vb37r.3rejr at ~2016.6.24..04.48.21..a235
187 ~your-urbit to ~another-urbit
205 ~your-urbit to ~another-urbit
188 in reply to: ~your-urbit:
206 in reply to: ~your-urbit:
189− > this is my message
207+ > This is my message.
190− that's my message!
208+ That's my message!
191
209
192If information got truncated — like happens for long URLs or expressions —
210If information got truncated — like happens for long URLs or expressions —
193or if there's additional information available — as is the case with
211or if there's additional information available — as is the case with
@@ -199,40 +217,40 @@ with `;;`, and so on.
199
217
200### Creating and managing circles
218### Creating and managing circles
201
219
202−`;create [type] %name 'description'`
220+###### `;create [type] %name 'description'`
203Creates and joins a circle, where `[type]` is any of the following:
221Creates and joins a circle, where `[type]` is any of the following:
204- `channel`: public circle. Has a blacklist for write control.
222- `channel`: public circle. Has a blacklist for write control.
205- `village`: invite-only circle.
223- `village`: invite-only circle.
206- `journal`: publicly readable, invite-only for writing.
224- `journal`: publicly readable, invite-only for writing.
207- `mailbox`: publicly writeable, can only be read by its host.
225- `mailbox`: publicly writeable, can only be read by its host.
208
226
209−`;delete %name 'optional reason'`
227+###### `;delete %name 'optional reason'`
210Deletes a circle. If a reason is specified, that gets sent to all
228Deletes a circle. If a reason is specified, that gets sent to all
211subscribers before the circle gets deleted.
229subscribers before the circle gets deleted.
212
230
213−`;depict %name 'description'`
231+###### `;depict %name 'description'`
214Changes the description of circle `%name`.
232Changes the description of circle `%name`.
215
233
216−`;filter %name [capitals] [unicode]`
234+###### `;filter %name [capitals] [unicode]`
217Configures the message filter for circle `%name`: whether to allow
235Configures the message filter for circle `%name`: whether to allow
218capital and/or unicode characters. `y`/`&`/`true` for allowed,
236capital and/or unicode characters. `y`/`&`/`true` for allowed,
219`n`/`|`/`false` for disallowed.
237`n`/`|`/`false` for disallowed.
220
238
221−`;invite %name ~someone`
239+###### `;invite %name ~someone`
222Invite someone into your circle `%name`. If they were previously banished,
240Invite someone into your circle `%name`. If they were previously banished,
223removes them from the blacklist.
241removes them from the blacklist.
224Can also invite multiple ships at once, `~comma, ~separated`.
242Can also invite multiple ships at once, `~comma, ~separated`.
225
243
226−`;banish %name ~someone`
244+###### `;banish %name ~someone`
227Banish someone from your circle `%name`. If they were previously invited,
245Banish someone from your circle `%name`. If they were previously invited,
228removes them from the whitelist.
246removes them from the whitelist.
229Can also banish multiple ships at once, `~comma, ~separated`.
247Can also banish multiple ships at once, `~comma, ~separated`.
230
248
231−`;source %name ~other/circle`
249+###### `;source %name ~other/circle`
232Adds `~other/circle` as a source for circle `%name`. This causes all
250Adds `~other/circle` as a source for circle `%name`. This causes all
233messages sent to `~other/circle` to also appear in `%name`.
251messages sent to `~other/circle` to also appear in `%name`.
234
252
235−`;unsource %name ~other/circle`
253+###### `;unsource %name ~other/circle`
236Removes `~other/circle` as a source for circle `%name`.
254Removes `~other/circle` as a source for circle `%name`.
237
255
238### Membership
256### Membership
@@ -240,37 +258,40 @@ Removes `~other/circle` as a source for circle `%name`.
240If you have joined a circle, you can make this information publicly
258If you have joined a circle, you can make this information publicly
241available to help others find that circle as well.
259available to help others find that circle as well.
242
260
243−`;show ~some/circle`
261+###### `;show ~some/circle`
244Adds a circle to your public membership list.
262Adds a circle to your public membership list.
245
263
246−`;hide ~some/circle`
264+###### `;hide ~some/circle`
247Removes a circle from your public membership list.
265Removes a circle from your public membership list.
248
266
249### Status
267### Status
250
268
251You'll see status notifications when people enter or leave stations
269You'll see status notifications when people enter or leave stations
252−you're subscribed to.
253
270
254−`;set quiet`
271+###### `;set quiet`
255Turn off status (and config) notifications.
272Turn off status (and config) notifications.
256
273
257−`;unset quiet`
274+###### `;unset quiet`
258Turn on status (and config) notifications.
275Turn on status (and config) notifications.
259
276
260−`;who`
277+###### `;who`
261List everyone in all your subscribed circles. Optionally specify a
278List everyone in all your subscribed circles. Optionally specify a
262specific circle to list members of just those.
279specific circle to list members of just those.
263
280
281+You'll see presence notifications when people enter or leave stations
282+you're subscribed to.
283+
264−`;attend ~some/circle [presence]`
284+###### `;attend ~some/circle [presence]`
265Manually set your presence to show up as one of the following. (In the
285Manually set your presence to show up as one of the following. (In the
266future, a sufficiently advanced client can automatically set these for
286future, a sufficiently advanced client can automatically set these for
267you.)
287you.)
288+
268- `talk` - typing
289- `talk` - typing
269- `hear` - listening
290- `hear` - listening
270- `idle` - inactive
291- `idle` - inactive
271- `gone` - not present
292- `gone` - not present
272
293
273−`;name ~some/circle 'my handle'`
294+###### `;name ~some/circle 'my handle'`
274Set a handle ("name") for yourself in a specific circle. It will display
295Set a handle ("name") for yourself in a specific circle. It will display
275to users who have done `;set nicks`, but gets truncated if it's longer
296to users who have done `;set nicks`, but gets truncated if it's longer
276than 14 characters.
297than 14 characters.
@@ -280,7 +301,6 @@ than 14 characters.
280An audience consists of one or more messaging targets. These can be
301An audience consists of one or more messaging targets. These can be
281circles or ships. (In the latter case, it's secretly the `~ship/inbox`
302circles or ships. (In the latter case, it's secretly the `~ship/inbox`
282circle.)
303circle.)
283−
284### Circle glyphs
304### Circle glyphs
285
305
286Glyphs are assigned by circle hash out of the following list
306Glyphs are assigned by circle hash out of the following list
@@ -290,10 +310,10 @@ Glyphs are assigned by circle hash out of the following list
290Alphanumeric characters and `|#;:*~_` are reserved; all others (the
310Alphanumeric characters and `|#;:*~_` are reserved; all others (the
291above list, and `\/!?({<`) can be manually assigned.
311above list, and `\/!?({<`) can be manually assigned.
292
312
293−`;bind + /urbit-test`
313+###### `;bind + /urbit-test`
294Assigns the `+` glyph to `/urbit-test`.
314Assigns the `+` glyph to `/urbit-test`.
295
315
296−`;unbind + /urbit-test`
316+###### `;unbind + /urbit-test`
297Unassigns the `+` glyph from `/urbit-test`.
317Unassigns the `+` glyph from `/urbit-test`.
298
318
299To see what circle is bound to a glyph:
319To see what circle is bound to a glyph:
@@ -305,8 +325,9 @@ To see what circle is bound to a glyph:
305
325
306Received posts are prefixed with a glyph to let you know what the
326Received posts are prefixed with a glyph to let you know what the
307audience is. You can activate an individual post to see the full
327audience is. You can activate an individual post to see the full
308−audience.
328+audience.
329+
309−There are a few special-purpose glyphs.
330+There are a few special-purpose glyphs:
310
331
311- `|` - Informational messages
332- `|` - Informational messages
312- `:` - Posts directly to you
333- `:` - Posts directly to you
@@ -328,20 +349,20 @@ Here we're talking directly to `~dannum-mitryl`:
328
349
329#### Configuration
350#### Configuration
330
351
331−`;~urbit/station`
352+###### `;~urbit/circle`
332−Set audience to `~urbit/station`.
353+Set audience to `~urbit/circle`.
333
354
334−`;=`
355+###### `;=`
335−Set audience to the station bound to the `=` glyph.
356+Set audience to the station bound to the `=` glyph
336
357
337−`;~dannum-mitryl`
358+###### `;~dannum-mitryl`
338Set audience to `~dannum-mitryl` (a direct post).
359Set audience to `~dannum-mitryl` (a direct post).
339
360
340−`;%station`
361+###### `;%circle`
341−Set audience to a station on your own ship.
362+Set audience to a circle on your own ship
342
363
343−`;~dannum-mitryl this is a private message`
364+###### `;~dannum-mitryl this is a private message`
344−Set the audience and send a post to it. This works for all of the above.
365+Set the audience and send a post in the same line. This works for all of the above.
345
366
346Your audience is configured with regard to the following rules (in order):
367Your audience is configured with regard to the following rules (in order):
347
368
@@ -351,26 +372,26 @@ Your audience is configured with regard to the following rules (in order):
351
372
352### Local nicknames
373### Local nicknames
353
374
354−`;nick`
375+###### `;nick`
355List all local nicknames.
376List all local nicknames.
356
377
357−`;nick ~some-urbit`
378+###### `;nick ~some-urbit`
358Look up a nickname.
379Look up a nickname.
359
380
360−`;nick plato`
381+###### `;nick plato`
361Search in reverse.
382Search in reverse.
362
383
363−`;nick ~some-urbit plato`
384+###### `;nick ~some-urbit plato`
364Create a nickname.
385Create a nickname.
365−
386+
366−`;nick ~some-urbit ~`
387+###### `;nick ~some-urbit ~`
367Clear an assigned nickname.
388Clear an assigned nickname.
368
389
369−`;set nicks`
390+###### `;set nicks`
370Show nicknames instead of urbit names. If no local nickname is set, uses
391Show nicknames instead of urbit names. If no local nickname is set, uses
371that user's handle. If the user has no handle, just the urbit name.
392that user's handle. If the user has no handle, just the urbit name.
372
393
373−`;unset nicks`
394+###### `;unset nicks`
374Show urbit names instead of nicknames.
395Show urbit names instead of nicknames.
375
396
376Nicknames and handles longer than 14 character will be truncated in
397Nicknames and handles longer than 14 character will be truncated in
@@ -379,22 +400,22 @@ phonebook.
379
400
380### Miscellaneous configuration
401### Miscellaneous configuration
381
402
382−`;set showtime`
403+###### `;set showtime`
383Show the timestamp for each message.
404Show the timestamp for each message.
384
405
385−`;unset showtime`
406+###### `;unset showtime`
386−Stop showing the timestamp for each message.
407+Stop showing the timestamp for each message.
387
408
388−`;set timezone [+/-][hours]`
409+###### `;set timezone [+/-][hours]`
389Adjust the display of the timestamps to a specific timezone. Relative to UTC.
410Adjust the display of the timestamps to a specific timezone. Relative to UTC.
390
411
391−`;set notify`
412+###### `;set notify`
392Emit a terminal bell sound if your six-syllable ship name is mentioned in
413Emit a terminal bell sound if your six-syllable ship name is mentioned in
393a message.
414a message.
394
415
395−`;unset notify`
416+###### `;unset notify`
396Do not notify when your ship name is mentioned.
417Do not notify when your ship name is mentioned.
397
418
398−`;set width [number]`
419+###### `;set width [number]`
399Set the rendering width of `:talk` to a specific number of characters.
420Set the rendering width of `:talk` to a specific number of characters.
400(Minimum of 30.)
421(Minimum of 30.)
docs/using/setup.md+20−23
@@ -1,6 +1,7 @@
1---
1---
2−navhome: '/docs'
2+navhome: /docs/
3+navuptwo: true
3−next: True
4+next: true
4sort: 2
5sort: 2
5title: Setup
6title: Setup
6---
7---
@@ -46,12 +47,12 @@ Welcome!
46By default your urbit is quite bare-bones. Let's stroll through what's
47By default your urbit is quite bare-bones. Let's stroll through what's
47already running:
48already running:
48
49
49−### Shell — `:dojo`
50+### Shell — Dojo
50
51
51The command prompt in front of you is a simple shell and Hoon REPL.
52The command prompt in front of you is a simple shell and Hoon REPL.
52Let's make sure it works:
53Let's make sure it works:
53
54
54− ~fitund-macrep:dojo> (add 2 2)
55+ ~your-urbit:dojo> (add 2 2)
55
56
56Should produce:
57Should produce:
57
58
@@ -60,40 +61,36 @@ Should produce:
60
61
61Good.
62Good.
62
63
63−### Messaging — `:talk`
64+### Messaging — Talk
64
65
65Use `ctrl-x` to change your prompt. Let's join the main Urbit chat
66Use `ctrl-x` to change your prompt. Let's join the main Urbit chat
66−channel.
67+channel, `/urbit-meta`:
67
68
68−For planets:
69+ ~your-urbit:talk[] ;join /urbit-meta
69
70
70− ~fitund-macrep:talk() ;join /urbit-meta
71−
72−For comets:
73−
74− ~ticlen-nidrup-larwyl-rivtyc--folsel-tocwyl-hosrex-nimder:talk() ;join ~binzod/urbit-meta
75−
76−`:talk` is stateful, so your urbit will download a backlog.
71+Talk is stateful, so your urbit will download a backlog.
77`/urbit-meta` is the place to ask questions, get help and talk about
72`/urbit-meta` is the place to ask questions, get help and talk about
78anything Urbit-related.
73anything Urbit-related.
79
74
80−### Web — `:tree`
75+### Web — Tree
81
76
82Urbit is also accessible through the web. Try opening:
77Urbit is also accessible through the web. Try opening:
83
78
84 http://localhost:8080/
79 http://localhost:8080/
85
80
86−in your favorite browser. You'll be prompted to use `+code`. This page
81+in your favorite browser. You'll be prompted to use `+code` in your Dojo
82+to retrive your password and log in. This page was generated by Tree,
87−was generated by `:tree`, the basic Urbit web interface. You can also
83+the basic Urbit web interface. You can also access your urbit through
88−access your urbit through `http://fintud-macrep.urbit.org` (where
84+`http://your-urbit.urbit.org`. Note that this latter approach is slower
89−`fintud-macrep` is your planet name).
85+for the time being because we proxy over the Urbit network, Ames, but a
86+better, faster solution for this is in the works.
90
87
91−### Filesystem — `%clay`
88+### Filesystem — Clay
92
89
93−`%clay`, the Urbit filesystem, isn't mounted to unix by default. Switch
90+Clay, the Urbit filesystem, isn't mounted to Unix by default. Switch
94−to the `:dojo` prompt and run:
91+to the Dojo prompt and run:
95
92
96− ~fitund-macrep:dojo> |mount %
93+ ~your-urbit:dojo> |mount %
97
94
98This should produce:
95This should produce:
99
96
docs/using/shell.md+9−8
@@ -1,18 +1,19 @@
1---
1---
2−navhome: '/docs'
2+navhome: /docs/
3+navuptwo: true
3−next: True
4+next: true
4−sort: 5
5+sort: 6
5−title: Shell (:dojo)
6+title: Shell (Dojo)
6---
7---
7
8
8−# Shell (`:dojo`)
9+# Shell (Dojo)
9
10
10<div class="row">
11<div class="row">
11
12
12<div class="col-md-8">
13<div class="col-md-8">
13
14
14−The `:dojo` is the place to quickly experiment with Urbit. On the
15+The Dojo is the place to quickly experiment with Urbit. On the
15−surface the `:dojo` is just a Hoon REPL. On the inside, the `:dojo` is a
16+surface the Dojo is just a Hoon REPL. On the inside, the Dojo is a
16system for operating on and transforming data in Urbit.
17system for operating on and transforming data in Urbit.
17
18
18</div>
19</div>
@@ -232,7 +233,7 @@ Create a random moon (from any planet):
232
233
233### Variables
234### Variables
234
235
235−You can use `=` to set an environment variable in `:dojo`, but there are
236+You can use `=` to set an environment variable in Dojo, but there are
236a few reserved names that have special uses.
237a few reserved names that have special uses.
237
238
238#### `dir`
239#### `dir`
docs/using/urb.mddeleted−356
@@ -1,356 +0,0 @@
1−---
2−navhome: /docs/
3−sort: 8
4−title: From Unix
5−---
6−
7−<div class="row">
8−<div class="col-md-8">
9−
10−# Using Urbit from Unix
11−
12−With `urb` at your Unix command line, you can execute hoon, run
13−dojo commands, and more. Additionally, with `fuse`, you can
14−inspect the urbit namespace.
15−
16−</div>
17−</div>
18−
19−## Installation
20−
21−These commands are in the a [separate
22−repo](https://github.com/urbit/urb). Clone this repo to get the
23−commands.
24−
25−You'll also need the `requests` and `fuse` libraries for python.
26−If you have `pip`, you can just run:
27−
28−```
29−pip install requests fuse-python
30−```
31−
32−Otherwise, on Ubuntu, run:
33−
34−```
35−apt-get install python-requests python-fuse
36−```
37−
38−Then you can either run the python commands from the git repo, or
39−put them somewhere in your path.
40−
41−## `urb`
42−
43−`urb` transfers data from a source to a sink. Examples of data
44−sources include literal data, a file, a URL, or some
45−tranformation of another source. Examples of data sinks are
46−stdout, output file, POST request, or dojo command.
47−
48−Here are some examples. This takes the literal data "hello
49−world" and sends it to stdout (the default sink).
50−
51− urb --data 'hello world'
52−
53−Let's run some hoon code at the dojo.
54−
55− urb --dojo '(add 2 2)'
56−
57−Let's convert a markdown file to html.
58−
59− urb --data @@file.md -m md -m html
60−
61−Mount the `%home` desk. This syncs the `home` desk into the pier
62−directory.
63−
64− urb --dojo '+hood/mount /=home=' --app hood
65−
66−### Sources
67−
68−Sources can be any of the following:
69−
70−- `-d, --dojo command` runs a dojo command. This is commonly
71− naked hoon code, but it can also be a generator, or any of the
72− other ways the dojo gets data.
73−
74−- `-D, --data text` is literal text data, as a cord.
75−
76−- `-c, --clay path` pulls data from Urbit's filesystem.
77−
78−- `-u, --url url` pulls data from a URL.
79−
80−- `-m, --mark mark source` converts the output from another source to
81− a new 'mark' (datatype).
82−
83−- `-H, --hoon code source` transforms the output of another
84− source by running it through some hoon code.
85−
86−- `[source-0 source-1 ...]`. Sources can be combined into tuples
87− of different sources.
88−
89−Any of the arguments to a source (except in the "compound
90−sources" `--mark` and `--hoon`) can be replaced by `-` to
91−represent stdin or `@@filename` to pull data in from a Unix file.
92−Thus, `urb [-D @@file1 -D - -D @@file2]` is equivalent to Unix's
93−`cat file1 - file2`.
94−
95−Additionally, if no source is specified, `--data -` (stdin as
96−literal text data) is assumed.
97−
98−### Sinks
99−
100−- `-s, --stdout` outputs to stdout. This is the default.
101−
102−- `-f, --output-file path` writes to a unix file.
103−
104−- `-C, --output-clay path` writes to Urbit's filesystem.
105−
106−- `-U, --output-url url` sends a POST request with the data to
107− the URL.
108−
109−- `-p, --app app` sends the data to an urbit app.
110−
111−- `-x, --command` outputs to a literal dojo command.
112−
113−## `fuse`
114−
115−Urbit's namespace is accessible through the `fuse` command.
116−`fuse` takes all the normal FUSE arguments, which you can see
117−with `fuse -h`. Generally, you just run `fuse MOUNT-POINT`.
118−
119−When accessing the namespace through `fuse`, everything is
120−read-only. If you want to write to Clay, mount a desk, as
121−described above.
122−
123−Let's look first in the Clay portion of the Urbit namespace.
124−Assume we've mounted to `./pt`.
125−
126− $ ls ./pt/c/=/=/=
127− app arvo gen lib mar ren sec sur web
128− $ ls ./pt/c/=/=/=/arvo
129− ames behn clay dill eyre ford gall hoon zuse
130−
131−Those `=`s aren't decorative. The first `=` means "current
132−ship", the second "current desk", and the third "current
133−revision". Let's try something a little more exciting.
134−
135−This runs the Unix `diff` command on the first and current
136−versions of the `app/gh/hoon` file, showing all the changes we've
137−made to the file.
138−
139−```
140−$ diff pt/c/=/=/{1,=}/app/gh/hoon
141−73c73,75
142−< (malt (turn issues |=(issue:gh [(rsh 3 2 (scot %ui number)) ~])))
143−---
144−> %- malt ^- (list {@ta $~})
145−> :- [%gh-list-issues ~]
146−> (turn issues |=(issue:gh [(rsh 3 2 (scot %ui number)) ~]))
147−92c94,101
148−< read-y=(read-get /issues)
149−---
150−> read-y=(read-static %gh-list-issues ~)
151−> sigh-x=sigh-list-issues-x
152−> sigh-y=sigh-list-issues-y
153−> ==
154−> ^- place :: /issues/mine/<mark>
155−> :* guard={$issues $mine @t $~}
156−> read-x=read-null
157−> read-y=|=(pax/path [ost %diff %arch `0vsen.tinel ~])
158−126c135
159−< ^- place :: /issues/by-repo/<user>/<repo>
160−---
161−> ^- place :: /issues/by-repo/<user>/<repo>/<number>
162−131c140,146
163−< read-y=(read-static ~)
164−---
165−> ^= read-y
166−> |= pax/path
167−> %. pax
168−> ?: ((sane %tas) -.+>+>.pax)
169−> (read-static ~)
170−> (read-static %gh-issue ~)
171−> ::
172−137a153,159
173−> sigh-y=sigh-strange
174−> ==
175−> ^- place :: /issues/by-repo/<u>/<r>/<n>/<mark>
176−> :* guard={$issues $by-repo @t @t @t @t $~}
177−> read-x=read-null
178−> read-y=|=(pax/path [ost %diff %arch `0vsen.tinel ~])
179−> sigh-x=sigh-strange
180−```
181−
182−Urbit's namespace is not just revisioned, but global. Here's a
183−diff of our version of `arvo/gall/hoon` compared to the one on
184−the `~bud` urbit.
185−
186−```
187−$ diff pt/c/{~bud,=}/=/=/arvo/gall/hoon
188−2d1
189−<
190−640a640,644
191−> =+ ?. ?=($x ren)
192−> [mar=%$ tyl=tyl]
193−> =+ `path`(flop tyl)
194−> ?> ?=(^ -)
195−> [mar=i tyl=(flop t)]
196−643c647
197−< ((slog leaf+"peek find fail" >tyl< ~) [~ ~])
198−---
199−> ((slog leaf+"peek find fail" >tyl< >mar< ~) [~ ~])
200−654a659,660
201−> ?. =(mar p.q.caz)
202−> [~ ~]
203−1308a1315,1316
204−> ?. ?=(^ tyl)
205−> ~
206−```
207−
208−Besides Clay, the namespace contains Gall apps. One common usage
209−of the app namespace is to expose APIs. For example, if you
210−start the `%gh` app (`|start %gh`), you can do things like `cat`
211−an issue from a repository.
212−
213−```
214−$ cat pt/g/=/gh/=/issues/by-repo/philipcmonktest/testing/7/txt
215−title: big news! (#7)
216−state: open
217−creator: philipcmonktest
218−created-at: 2016-03-24T22:27:33Z
219−assignee: philipcmonktest
220−labels: invalid, wontfix, help wanted
221−comments: 0
222−url: https://api.github.com/repos/philipcmonktest/testing/issues/7
223−
224−Yup, that's it. i mean, maybe it's a bit longer than that.
225−
226−But you get the point, right?
227−
228−Code `is` cool!
229−```
230−
231−Or all open issues for a repository.
232−
233−```
234−$ cat pt/g/=/gh/=/issues/by-repo/philipcmonktest/testing/txt
235−title: i found a bug! (#11)
236−state: open
237−creator: philipcmonktest
238−created-at: 2016-04-14T23:14:49Z
239−assignee: none
240−labels:
241−comments: 1
242−url: https://api.github.com/repos/philipcmonktest/testing/issues/11
243−
244−
245−----------------------------------------
246−title: more newz (#8)
247−state: open
248−creator: philipcmonktest
249−created-at: 2016-03-24T22:29:16Z
250−assignee: none
251−labels:
252−comments: 4
253−url: https://api.github.com/repos/philipcmonktest/testing/issues/8
254−
255−Yup, that's it. i mean, maybe it's a bit longer than that.
256−
257−But you get the point, right?
258−
259−Code `is` cool!
260−----------------------------------------
261−title: big news! (#7)
262−state: open
263−creator: philipcmonktest
264−created-at: 2016-03-24T22:27:33Z
265−assignee: philipcmonktest
266−labels: invalid, wontfix, help wanted
267−comments: 0
268−url: https://api.github.com/repos/philipcmonktest/testing/issues/7
269−
270−Yup, that's it. i mean, maybe it's a bit longer than that.
271−
272−But you get the point, right?
273−
274−Code `is` cool!
275−----------------------------------------
276−title: something different (#4)
277−state: open
278−creator: philipcmonktest
279−created-at: 2016-01-26T21:45:08Z
280−assignee: philipcmonktest
281−labels: duplicate, help wanted, question, bug
282−comments: 1
283−url: https://api.github.com/repos/philipcmonktest/testing/issues/4
284−```
285−
286−Don't like the textual format? How about we get the raw JSON
287−(and prettyprint it).
288−
289−```
290−$ cat pt/g/=/gh/=/issues/by-repo/philipcmonktest/testing/7/json | python -m json.tool
291−{
292− "assignee": {
293− "avatar_url": "https://avatars.githubusercontent.com/u/16787461?v=3",
294− "events_url": "https://api.github.com/users/philipcmonktest/events{/privacy}",
295− "followers_url": "https://api.github.com/users/philipcmonktest/followers",
296− "following_url": "https://api.github.com/users/philipcmonktest/following{/other_user}",
297− "gists_url": "https://api.github.com/users/philipcmonktest/gists{/gist_id}",
298− "gravatar_id": "",
299− "html_url": "https://github.com/philipcmonktest",
300− "id": 16787461,
301− "login": "philipcmonktest",
302− "organizations_url": "https://api.github.com/users/philipcmonktest/orgs",
303− "received_events_url": "https://api.github.com/users/philipcmonktest/received_events",
304− "repos_url": "https://api.github.com/users/philipcmonktest/repos",
305− "site_admin": false,
306− "starred_url": "https://api.github.com/users/philipcmonktest/starred{/owner}{/repo}",
307− "subscriptions_url": "https://api.github.com/users/philipcmonktest/subscriptions",
308− "type": "User",
309− "url": "https://api.github.com/users/philipcmonktest"
310− },
311− "body": "Yup, that's it. i mean, maybe it's a bit longer than that.\r\n\r\nBut you get the point, right?\r\n\r\nCode `is` cool!",
312− "closed_at": null,
313− "closed_by": null,
314− "comments": 0,
315− "comments_url": "https://api.github.com/repos/philipcmonktest/testing/issues/7/comments",
316− "created_at": "2016-03-24T22:27:33Z",
317− "events_url": "https://api.github.com/repos/philipcmonktest/testing/issues/7/events",
318− "html_url": "https://github.com/philipcmonktest/testing/issues/7",
319− "id": 143377108,
320− "labels": [
321− {
322− "color": "ffffff",
323− "name": "wontfix",
324− "url": "https://api.github.com/repos/philipcmonktest/testing/labels/wontfix"
325− }
326− ],
327− "labels_url": "https://api.github.com/repos/philipcmonktest/testing/issues/7/labels{/name}",
328− "locked": false,
329− "milestone": null,
330− "number": 7,
331− "repository_url": "https://api.github.com/repos/philipcmonktest/testing",
332− "state": "open",
333− "title": "big news!",
334− "updated_at": "2016-03-24T22:27:33Z",
335− "url": "https://api.github.com/repos/philipcmonktest/testing/issues/7",
336− "user": {
337− "avatar_url": "https://avatars.githubusercontent.com/u/16787461?v=3",
338− "events_url": "https://api.github.com/users/philipcmonktest/events{/privacy}",
339− "followers_url": "https://api.github.com/users/philipcmonktest/followers",
340− "following_url": "https://api.github.com/users/philipcmonktest/following{/other_user}",
341− "gists_url": "https://api.github.com/users/philipcmonktest/gists{/gist_id}",
342− "gravatar_id": "",
343− "html_url": "https://github.com/philipcmonktest",
344− "id": 16787461,
345− "login": "philipcmonktest",
346− "organizations_url": "https://api.github.com/users/philipcmonktest/orgs",
347− "received_events_url": "https://api.github.com/users/philipcmonktest/received_events",
348− "repos_url": "https://api.github.com/users/philipcmonktest/repos",
349− "site_admin": false,
350− "starred_url": "https://api.github.com/users/philipcmonktest/starred{/owner}{/repo}",
351− "subscriptions_url": "https://api.github.com/users/philipcmonktest/subscriptions",
352− "type": "User",
353− "url": "https://api.github.com/users/philipcmonktest"
354− }
355−}
356−```
docs/using/web.md+8−8
@@ -1,18 +1,18 @@
1---
1---
2navhome: /docs/
2navhome: /docs/
3−next: true
3+navuptwo: true
4−sort: 7
4+sort: 8
5−title: Web
5+title: Web (Eyre)
6---
6---
7
7
8−# Web
8+# Web (Eyre)
9
9
10<div class="row">
10<div class="row">
11<div class="col-md-8">
11<div class="col-md-8">
12
12
13−Your Urbit runs its own webserver, `%eyre`, that handles all things HTTP. Here we'll cover the features of `%eyre` that most resemble a traditional web server.
13+Your Urbit runs its own webserver, Eyre, that handles all things HTTP. Here we'll cover the features of Eyre that most resemble a traditional web server.
14
14
15−By default `%eyre` uses Tree, which is sort of like a combination of [Jekyll](https://jekyllrb.com/) or [Kirby](https://getkirby.com/) and Finder on OSX. Tree is a simple ui for browsing the contents of the filesystem, statically publishing a blog or any kind of content and for running single-page apps.
15+By default Eyre uses Tree, which is sort of like a combination of [Jekyll](https://jekyllrb.com/) or [Kirby](https://getkirby.com/) and Finder on OSX. Tree is a simple ui for browsing the contents of the filesystem, statically publishing a blog or any kind of content and for running single-page apps.
16
16
17Tree was built primarily to display both our documentation and the contents of `urbit.org`. We provide a few simple examples [here](#-examples) of how to publish using Tree. If you're interested in doing anything complex it's worth checking out the [docs source](https://github.com/urbit/docs) and the [urbit.org](https://github.com/urbit/urbit.org) source.
17Tree was built primarily to display both our documentation and the contents of `urbit.org`. We provide a few simple examples [here](#-examples) of how to publish using Tree. If you're interested in doing anything complex it's worth checking out the [docs source](https://github.com/urbit/docs) and the [urbit.org](https://github.com/urbit/urbit.org) source.
18
18
@@ -52,7 +52,7 @@ Now modify `/sandbox/web/test.md` to list the children using the `<list/>` JSX:
52 This is a simple markdown file.
52 This is a simple markdown file.
53
53
54 <div><list /></div>
54 <div><list /></div>
55−
55+
56To view your file rendered using tree:
56To view your file rendered using tree:
57
57
58 http://localhost:8080/test/
58 http://localhost:8080/test/
@@ -289,7 +289,7 @@ Each JSON message sent to your Urbit needs an app endpoint. Can be set as a glo
289
289
290### `window.urb.oryx`
290### `window.urb.oryx`
291
291
292−CSRF token. Written to the page by `%eyre`, our webserver, when logged in. Required part of any authenticated request and included by default.
292+CSRF token. Written to the page by Eyre, our webserver, when logged in. Required part of any authenticated request and included by default.
293
293
294### `window.urb.req(method,url,params,json,cb)`
294### `window.urb.req(method,url,params,json,cb)`
295
295