git.iko.soy/urbit.org
on master help sign in
Merge pull request #498 from urbit/urbit-help
0284c12Morgan Sutherland
concepts/contributing.md+1−1
compare with master
unifiedsplit
@@ -22,7 +22,7 @@ Urbit is both code and community. We have guidelines for the former, and we also
22
22
23Urbit is a decentralized system, both technically and in spirit. This means that no one, Tlon Corp. or otherwise, has the technical ability to police the entire network. But we do admit that moderation is necessary; we just think that it’s not strictly a technical problem.
23Urbit is a decentralized system, both technically and in spirit. This means that no one, Tlon Corp. or otherwise, has the technical ability to police the entire network. But we do admit that moderation is necessary; we just think that it’s not strictly a technical problem.
24
24
25−What we can do, and what we propose to do in this document, is define how we plan on moderating our little, but important, corner of Urbit. We define the limits of our jurisdiction as the general-purpose discussion channel `/urbit-help`, our forum, `fora` and, adjacently, the GitHub issues on any of the [official urbit repos](https://github.com/urbit).
25+What we can do, and what we propose to do in this document, is define how we plan on moderating our little, but important, corner of Urbit. We define the limits of our jurisdiction as the general-purpose discussion channel `~dopzod/urbit-help`, our forum, `fora` and, adjacently, the GitHub issues on any of the [official urbit repos](https://github.com/urbit).
26
26
27Our hope is that the system established here can serve as a model for other corners of Urbit. But it bears repeating: **Tlon is technically incapable of moderating the Urbit network in general**.
27Our hope is that the system established here can serve as a model for other corners of Urbit. But it bears repeating: **Tlon is technically incapable of moderating the Urbit network in general**.
28
28
learn/arvo/hall.md−8
@@ -173,14 +173,6 @@ Applications that use Hall, especially clients, are encouraged to use the defaul
173
173
174As an example, Talk operates like this, serving as an interface for reading from and managing the user's mailbox. Local stories are subscribed to through the `inbox`, which ends up containing all messages the user receives.
174As an example, Talk operates like this, serving as an interface for reading from and managing the user's mailbox. Local stories are subscribed to through the `inbox`, which ends up containing all messages the user receives.
175
175
176−### Federation
177−
178−Some places, like `urbit-help`, will want to be easily accessible to everyone on the network, and actually support the load that comes with that. Both of these desires can be achieved through federation.
179−
180−With federation, stories and any changes to them trickle down from ~zod, to other galaxies, to their stars. Only changes to messages and presence can also move upstream, from stars, to galaxies, to ~zod (and then back down again).
181−
182−This way, all planets and comets will be able to subscribe to `/urbit-help` (that is, the `urbit-help` circle on their parent ship) and get all updates on the story, regardless of where on the network they originated.
183−
184### Public membership
176### Public membership
185
177
186To aid in discoverability of circles, it is possible for users to make their participation in any given circle public. This data can then be used by things like profile widgets, or read out directly by other users.
178To aid in discoverability of circles, it is possible for users to make their participation in any given circle public. This data can then be used by things like profile widgets, or read out directly by other users.
reference/glossary.md+1−1
@@ -440,7 +440,7 @@ _More information on Hall can be found [here](/docs/learn/arvo/arvo-internals/ha
440 specifically, it’s a named collection of messages created by and hosted on a
440 specifically, it’s a named collection of messages created by and hosted on a
441 ship’s Hall, usually represented as `~ship-name/circle-name`. On Talk,
441 ship’s Hall, usually represented as `~ship-name/circle-name`. On Talk,
442 Urbit’s built-in chat front-end, the first circle that you will likely
442 Urbit’s built-in chat front-end, the first circle that you will likely
443− encounter is `/urbit-help`.
443+ encounter is `~dopzod/urbit-help`.
444
444
445### Hood
445### Hood
446
446
using/messaging.md+56−68
@@ -7,8 +7,9 @@ Talk is the built-in frontend for the Urbit messaging and notifications
7protocol, Hall. Today we use Hall to chat and coordinate, but it's really
7protocol, Hall. Today we use Hall to chat and coordinate, but it's really
8a general purpose piece of infrastructure.
8a general purpose piece of infrastructure.
9
9
10−For the time being come join us in `/urbit-help` by using the
10+For the time being come join us in `~dopzod/urbit-help` by using the
11−'quickstart' section below.
11+'quickstart' section below. `~dopzod` is the host ship, and `/urbit-help` is the
12+channel on that ship.
12
13
13Today, Hall is sort of like a distributed, encrypted Slack that can be
14Today, Hall is sort of like a distributed, encrypted Slack that can be
14used from the CLI and the browser. There’s no central Hall server.
15used from the CLI and the browser. There’s no central Hall server.
@@ -27,45 +28,32 @@ take a look at its [documentation](../hall).
27## Quickstart
28## Quickstart
28
29
29The most common use of talk right now is as a single-instance of Slack: one main
30The most common use of talk right now is as a single-instance of Slack: one main
30−channel (`/urbit-help`) and direct messages. Everyone is more than welcome
31+channel (`~dopzod/urbit-help`) and direct messages. Everyone is more than welcome
31−in `/urbit-help`. It's the place to get help, ask questions and chat about
32+in `~dopzod/urbit-help`. It's the place to get help, ask questions and chat about
32Urbit in general.
33Urbit in general.
33
34
34There are two ways of using Talk: from the terminal running the Urbit process,
35There are two ways of using Talk: from the terminal running the Urbit process,
35or through a web UI available at `http://localhost:8080/~~/talk`. This
36or through a web UI available at `http://localhost:8080/~~/talk`. This
36quick-start guide will cover the first method.
37quick-start guide will cover the first method.
37
38
38−##### Joining a Channel
39+### Joining a Channel
39
40
40In Hall, a medium for a message is called a _circle_. There are four types of
41In Hall, a medium for a message is called a _circle_. There are four types of
41circles, but we for now we'll be dealing with the _channel_: a publicly
42circles, but we for now we'll be dealing with the _channel_: a publicly
42accessible chatroom for general use. We'll discuss the other three
43accessible chatroom for general use. We'll discuss the other three
43kinds in the [manual](#manual) section.
44kinds in the [manual](#manual) section.
44
45
45−Let's join the `/urbit-help` channel. Use `ctrl-x` to switch from Dojo to Talk.
46+Let's join the `~dopzod/urbit-help` channel. Use `ctrl-x` to switch from Dojo to Talk.
46−Then, :
47+Then:
47
48
48```
49```
49−~your-urbit:talk> ;join /urbit-help
50+~your-urbit:talk> ;join ~dopzod/urbit-help
50```
51```
51
52
52−You'll see something like:
53+Scrolling down your terminal window, you'll probably see the playback of
54+previous `~dopzod/urbit-help` messages that you missed.
53
55
54−```
55−--------------| ;join /urbit-help
56−--------------| :: onn /urbit-help
57−--------------| bound '=' {[hos=~binzod nom=%urbit-help]}
58−--------------| new = /urbit-help
59−--------------| /urbit-help: cap: For Urbit-related discussion. Politically
60− | correct and safe for work. Don't be rude.
61−--------------| /urbit-help: fit: caps:n unic:n
62−~your-urbit:talk=
63−```
64−
65−Scrolling down your terminal window, you'll probably also see the playback of
66−previous `/urbit-help` messages that you missed.
67−
68−Post a line to `/urbit-help`:
56+Post a line to `~dopzod/urbit-help:`
69
57
70```
58```
71~your-urbit:talk= Hello, world!
59~your-urbit:talk= Hello, world!
@@ -77,7 +65,7 @@ You'll see your message printed below messages from others that came before it:
77~your-urbit= Hello, world!
65~your-urbit= Hello, world!
78```
66```
79
67
80−##### Direct Messaging
68+### Direct Messaging
81
69
82To send a direct message to someone, first set your audience:
70To send a direct message to someone, first set your audience:
83
71
@@ -97,10 +85,10 @@ Now you and `~talsur-todres` can exchange messages directly.
97~your-urbit:talk[~talsur-todres] Hey buddy!
85~your-urbit:talk[~talsur-todres] Hey buddy!
98```
86```
99
87
100−To set your audience back to `/urbit-help`:
88+To set your audience back to `~dopzod/urbit-help`:
101
89
102```
90```
103−~your-urbit:talk[~talsur-todres] ;/urbit-help
91+~your-urbit:talk[~talsur-todres] ;~dopzod/urbit-help
104```
92```
105
93
106You'll see your prompt change back:
94You'll see your prompt change back:
@@ -109,7 +97,7 @@ You'll see your prompt change back:
109~your-urbit:talk=
97~your-urbit:talk=
110```
98```
111
99
112−You can also use the ASCII "glyph" assigned to your `/urbit-help` circle as a shortcut:
100+You can also use the ASCII "glyph" assigned to your `~dopzod/urbit-help` circle as a shortcut:
113
101
114```
102```
115~your-urbit:talk[~talsur-todres] ;=
103~your-urbit:talk[~talsur-todres] ;=
@@ -121,7 +109,7 @@ You can also use the ASCII "glyph" assigned to your `/urbit-help` circle as a sh
121Use `;leave` to unsubscribe from a channel:
109Use `;leave` to unsubscribe from a channel:
122
110
123```
111```
124−~your-urbit:talk= ;leave /urbit-help
112+~your-urbit:talk= ;leave ~dopzod/urbit-help
125```
113```
126
114
127The web UI ships as compiled JavaScript on your urbit, but has its own
115The web UI ships as compiled JavaScript on your urbit, but has its own
@@ -157,7 +145,7 @@ general use.
157A post can be a variety of different data structures. Let's look at the
145A post can be a variety of different data structures. Let's look at the
158ones you can use from within Talk: lines, URLs, Hoon and replies.
146ones you can use from within Talk: lines, URLs, Hoon and replies.
159
147
160−##### Lines
148+#### Lines
161
149
162A line is simply a string of text. Depending on the filtering rules set
150A line is simply a string of text. Depending on the filtering rules set
163by the circle's host, these may or may not include uppercase and Unicode
151by the circle's host, these may or may not include uppercase and Unicode
@@ -175,7 +163,7 @@ will print as
175~your-urbit sends a message.
163~your-urbit sends a message.
176```
164```
177
165
178−##### URLs
166+#### URLs
179
167
180A URL is any valid URL.
168A URL is any valid URL.
181
169
@@ -183,7 +171,7 @@ A URL is any valid URL.
183~your-urbit:talk= https://example.com/
171~your-urbit:talk= https://example.com/
184```
172```
185
173
186−##### Hoon
174+#### Hoon
187
175
188You can use Talk to evaluate Hoon code and share the result with everyone in a
176You can use Talk to evaluate Hoon code and share the result with everyone in a
189Hall circle. To do so, preface your Hoon with `#`.
177Hall circle. To do so, preface your Hoon with `#`.
@@ -199,7 +187,7 @@ will print as
1994
1874
200```
188```
201
189
202−##### Replies
190+#### Replies
203
191
204To indicate what you're saying is in direct response to a specific
192To indicate what you're saying is in direct response to a specific
205message, select the message (see Activating Lines below) and type your
193message, select the message (see Activating Lines below) and type your
@@ -265,7 +253,7 @@ As mentioned before, any urbit can host any number of circles. Existing circles
265can be deleted or modified with various commands. All commands in this section
253can be deleted or modified with various commands. All commands in this section
266shoild be sent from the `talk>` prompt.
254shoild be sent from the `talk>` prompt.
267
255
268−###### Create
256+#### Create
269
257
270Syntax: `;create [type] %name 'description'`
258Syntax: `;create [type] %name 'description'`
271
259
@@ -306,7 +294,7 @@ To delete our example above:
306sampel-palnet:talk> ;delete %coolbox 'people sent uncool messages'
294sampel-palnet:talk> ;delete %coolbox 'people sent uncool messages'
307```
295```
308
296
309−###### Change Description
297+#### Change Description
310
298
311Syntax: `;depict %name 'description'`
299Syntax: `;depict %name 'description'`
312
300
@@ -319,7 +307,7 @@ sampel-palnet:talk> ;depict %coolbox 'cool messages only. NO EXCEPTIONS.'
319```
307```
320
308
321<span id="filter"></span>
309<span id="filter"></span>
322−###### Filter
310+#### Filter
323
311
324Syntax: `;filter %name [capitals] [unicode]`
312Syntax: `;filter %name [capitals] [unicode]`
325
313
@@ -344,7 +332,7 @@ And we get the output:
344--------------| %coolbox: fit: caps:Y unic:n
332--------------| %coolbox: fit: caps:Y unic:n
345```
333```
346
334
347−###### Invite
335+#### Invite
348
336
349Syntax: `;invite %name ~someone`
337Syntax: `;invite %name ~someone`
350
338
@@ -358,7 +346,7 @@ For example:
358~sampel-palnet:talk> ;invite %coolbox ~lodleb-ritrul
346~sampel-palnet:talk> ;invite %coolbox ~lodleb-ritrul
359```
347```
360
348
361−###### Banish
349+#### Banish
362
350
363Syntax: `;banish %name ~someone`
351Syntax: `;banish %name ~someone`
364
352
@@ -366,7 +354,7 @@ Removes someone from your circle `%name`. If they were previously invited,
366removes them from the whitelist.
354removes them from the whitelist.
367Can also banish multiple ships at once, `~comma, ~separated`.
355Can also banish multiple ships at once, `~comma, ~separated`.
368
356
369−###### Source
357+#### Source
370
358
371Syntax: `;source %name ~other/circle`
359Syntax: `;source %name ~other/circle`
372
360
@@ -379,7 +367,7 @@ For example:
379~sampel-palnet:talk> ;source %coolbox ~marzod/urbit-help
367~sampel-palnet:talk> ;source %coolbox ~marzod/urbit-help
380```
368```
381
369
382−###### Unsource
370+#### Unsource
383
371
384Syntax: `;unsource %name ~other/circle`
372Syntax: `;unsource %name ~other/circle`
385
373
@@ -396,14 +384,14 @@ For example:
396If you have joined a circle, you can make this information publicly
384If you have joined a circle, you can make this information publicly
397available to help others find that circle as well.
385available to help others find that circle as well.
398
386
399−###### Show Membership
387+#### Show Membership
400
388
401Syntax: `;show ~some/circle`
389Syntax: `;show ~some/circle`
402
390
403Adds a circle to your public membership list on your Hall profile. Hall profiles
391Adds a circle to your public membership list on your Hall profile. Hall profiles
404are not used yet.
392are not used yet.
405
393
406−###### Hide Membership
394+#### Hide Membership
407
395
408Syntax: `;hide ~some/circle`
396Syntax: `;hide ~some/circle`
409
397
@@ -415,19 +403,19 @@ profiles are not used yet.
415You'll see status notifications when people enter or leave circles you're
403You'll see status notifications when people enter or leave circles you're
416subscribed to.
404subscribed to.
417
405
418−###### Notifications Off
406+#### Notifications Off
419
407
420Syntax: `;set quiet`
408Syntax: `;set quiet`
421
409
422Turn off status (and config) notifications.
410Turn off status (and config) notifications.
423
411
424−###### Notifications On
412+#### Notifications On
425
413
426Syntax: `;unset quiet`
414Syntax: `;unset quiet`
427
415
428Turn on status (and config) notifications.
416Turn on status (and config) notifications.
429
417
430−###### Who
418+#### Who
431
419
432Syntax: `;who`
420Syntax: `;who`
433
421
@@ -440,7 +428,7 @@ For example:
440~sampel-palnet:talk> ;who ~marzod/urbit-help
428~sampel-palnet:talk> ;who ~marzod/urbit-help
441```
429```
442
430
443−###### Attend
431+#### Attend
444
432
445Syntax: `;attend ~some/circle [presence]`
433Syntax: `;attend ~some/circle [presence]`
446
434
@@ -459,7 +447,7 @@ For example:
459~sampel-palnet:talk> ;attend ~marzod/urbit-help idle
447~sampel-palnet:talk> ;attend ~marzod/urbit-help idle
460```
448```
461
449
462−###### Set Display Name
450+#### Set Display Name
463
451
464Syntax: `;name ~some/circle 'my handle'`
452Syntax: `;name ~some/circle 'my handle'`
465
453
@@ -473,7 +461,7 @@ An audience consists of one or more messaging targets. These can be
473circles or ships. (In the latter case, it's secretly the `~ship/inbox`
461circles or ships. (In the latter case, it's secretly the `~ship/inbox`
474circle.)
462circle.)
475
463
476−#### Circle Glyphs
464+### Circle Glyphs
477
465
478Glyphs are found at the end of your prompt to as a quick indicator of where
466Glyphs are found at the end of your prompt to as a quick indicator of where
479your messages will be sent.
467your messages will be sent.
@@ -510,7 +498,7 @@ the prompt instead. Here we're talking directly to `~dannum-mitryl`:
510~sampel-palnet:talk[~dannum-mitryl]
498~sampel-palnet:talk[~dannum-mitryl]
511```
499```
512
500
513−###### Bind
501+#### Bind
514
502
515Syntax: `;bind [glyph] /circle-name`
503Syntax: `;bind [glyph] /circle-name`
516
504
@@ -522,7 +510,7 @@ For example:
522~sampel-palnet:talk> ;bind + /my-circle
510~sampel-palnet:talk> ;bind + /my-circle
523```
511```
524
512
525−###### Unbind
513+#### Unbind
526
514
527Syntax: `;unbind [glyph] /circle-name`
515Syntax: `;unbind [glyph] /circle-name`
528
516
@@ -550,31 +538,31 @@ There are a few special-purpose glyphs:
550
538
551### Configuration
539### Configuration
552
540
553−###### Set Audience
541+#### Set Audience
554
542
555`;~ship/circle`
543`;~ship/circle`
556
544
557Set audience to `~ship/circle`.
545Set audience to `~ship/circle`.
558
546
559−###### Set Audience by Glyph
547+#### Set Audience by Glyph
560
548
561Syntax: `;[glyph]`
549Syntax: `;[glyph]`
562
550
563Set audience to the circle previously bound to the chosen glyph.
551Set audience to the circle previously bound to the chosen glyph.
564
552
565−###### Set Audience to Ship
553+#### Set Audience to Ship
566
554
567syntax `;~ship`
555syntax `;~ship`
568
556
569Set audience to another ship.
557Set audience to another ship.
570
558
571−###### Set Audience to Own Circle
559+#### Set Audience to Own Circle
572
560
573Syntax: `;%circle`
561Syntax: `;%circle`
574
562
575Set audience to a circle on your own ship
563Set audience to a circle on your own ship
576
564
577−###### Set Audience + Send Message
565+#### Set Audience + Send Message
578
566
579Syntax: `;~dannum-mitryl this is a private message`
567Syntax: `;~dannum-mitryl this is a private message`
580
568
@@ -589,44 +577,44 @@ Your audience is configured with regard to the following rules (in order):
589
577
590### Local nicknames
578### Local nicknames
591
579
592−###### See Nicknames
580+#### See Nicknames
593
581
594Syntax: `;nick`
582Syntax: `;nick`
595
583
596List all local nicknames.
584List all local nicknames.
597
585
598−###### Find Nickname
586+#### Find Nickname
599
587
600Syntax: `;nick ~some-urbit`
588Syntax: `;nick ~some-urbit`
601
589
602Look up a nickname using the known ship-name.
590Look up a nickname using the known ship-name.
603
591
604−###### Reverse Find Nickname
592+#### Reverse Find Nickname
605
593
606syntax: `;nick plato`
594syntax: `;nick plato`
607
595
608Find a ship's name using its nickname.
596Find a ship's name using its nickname.
609
597
610−###### Set Nickname
598+#### Set Nickname
611
599
612Syntax: `;nick ~some-urbit plato`
600Syntax: `;nick ~some-urbit plato`
613
601
614Create a new nickname.
602Create a new nickname.
615
603
616−###### Clear Nickname
604+#### Clear Nickname
617
605
618Syntax: `;nick ~some-urbit ~`
606Syntax: `;nick ~some-urbit ~`
619
607
620Clear an assigned nickname.
608Clear an assigned nickname.
621
609
622−###### Display Nicks, Not Ship-Names
610+#### Display Nicks, Not Ship-Names
623
611
624Syntax: `;set nicks`
612Syntax: `;set nicks`
625
613
626Show nicknames instead of ship-names. If no local nickname is set, uses
614Show nicknames instead of ship-names. If no local nickname is set, uses
627that user's handle. If the user has no handle, just the urbit name.
615that user's handle. If the user has no handle, just the urbit name.
628
616
629−###### Display Ship-Names, Not Nicks
617+#### Display Ship-Names, Not Nicks
630
618
631Syntax: `;unset nicks`
619Syntax: `;unset nicks`
632
620
@@ -638,38 +626,38 @@ phonebook.
638
626
639### Miscellaneous configuration
627### Miscellaneous configuration
640
628
641−###### Show Timestamps
629+#### Show Timestamps
642
630
643Syntax: `;set showtime`
631Syntax: `;set showtime`
644
632
645Show the timestamp for each message.
633Show the timestamp for each message.
646
634
647−###### Hide Timestamps
635+#### Hide Timestamps
648
636
649Syntax: `;unset showtime`
637Syntax: `;unset showtime`
650
638
651Stop showing the timestamp for each message.
639Stop showing the timestamp for each message.
652
640
653−###### Change Time Zone
641+#### Change Time Zone
654
642
655Syntax: `;set timezone [+/-][hours]`
643Syntax: `;set timezone [+/-][hours]`
656
644
657Adjust the display of the timestamps to a specific timezone. Relative to UTC.
645Adjust the display of the timestamps to a specific timezone. Relative to UTC.
658
646
659−###### Sound Notification On
647+#### Sound Notification On
660
648
661Syntax: `;set notify`
649Syntax: `;set notify`
662
650
663Emit a terminal bell sound if your six-syllable ship name is mentioned in
651Emit a terminal bell sound if your six-syllable ship name is mentioned in
664a message.
652a message.
665
653
666−###### Sound Notification Off
654+#### Sound Notification Off
667
655
668Syntax `;unset notify`
656Syntax `;unset notify`
669
657
670Do not notify when your ship name is mentioned.
658Do not notify when your ship name is mentioned.
671
659
672−###### Set Width
660+#### Set Width
673
661
674Syntax: `;set width [number]`
662Syntax: `;set width [number]`
675
663