on master help sign in
Merge pull request #498 from urbit/urbit-help

corrects references to /urbit-help

commit0284c126ac46a72245c68d93af6f26347ad125f2 authorMorgan Sutherland <msutherl@users.noreply.github.com> dateTue 21 May 2019, 15:21 (7 years ago) parentfe9c9d4f16c862
4 files changed+58−78
concepts/contributing.md+1−1 learn/arvo/hall.md−8 reference/glossary.md+1−1 using/messaging.md+56−68
concepts/contributing.md+1−1
@@ -22,7 +22,7 @@ Urbit is both code and community. We have guidelines for the former, and we also
2222
2323Urbit 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.
2424
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).
2626
2727Our 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**.
2828
learn/arvo/hall.md−8
@@ -173,14 +173,6 @@ Applications that use Hall, especially clients, are encouraged to use the defaul
173173
174174As 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.
175175
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−
184176### Public membership
185177
186178To 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
440440 specifically, it’s a named collection of messages created by and hosted on a
441441 ship’s Hall, usually represented as `~ship-name/circle-name`. On Talk,
442442 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`.
444444
445445### Hood
446446
using/messaging.md+56−68
@@ -7,8 +7,9 @@ Talk is the built-in frontend for the Urbit messaging and notifications
77protocol, Hall. Today we use Hall to chat and coordinate, but it's really
88a general purpose piece of infrastructure.
99
10−For the time being come join us in `/urbit-help` by using the
11−'quickstart' section below.
10+For the time being come join us in `~dopzod/urbit-help` by using the
11+'quickstart' section below. `~dopzod` is the host ship, and `/urbit-help` is the
12+channel on that ship.
1213
1314Today, Hall is sort of like a distributed, encrypted Slack that can be
1415used from the CLI and the browser. There’s no central Hall server.
@@ -27,45 +28,32 @@ take a look at its [documentation](../hall).
2728## Quickstart
2829
2930The 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−in `/urbit-help`. It's the place to get help, ask questions and chat about
31+channel (`~dopzod/urbit-help`) and direct messages. Everyone is more than welcome
32+in `~dopzod/urbit-help`. It's the place to get help, ask questions and chat about
3233Urbit in general.
3334
3435There are two ways of using Talk: from the terminal running the Urbit process,
3536or through a web UI available at `http://localhost:8080/~~/talk`. This
3637quick-start guide will cover the first method.
3738
38−##### Joining a Channel
39+### Joining a Channel
3940
4041In Hall, a medium for a message is called a _circle_. There are four types of
4142circles, but we for now we'll be dealing with the _channel_: a publicly
4243accessible chatroom for general use. We'll discuss the other three
4344kinds in the [manual](#manual) section.
4445
45−Let's join the `/urbit-help` channel. Use `ctrl-x` to switch from Dojo to Talk.
46−Then, :
46+Let's join the `~dopzod/urbit-help` channel. Use `ctrl-x` to switch from Dojo to Talk.
47+Then:
4748
4849```
49−~your-urbit:talk> ;join /urbit-help
50+~your-urbit:talk> ;join ~dopzod/urbit-help
5051```
5152
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.
5355
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:`
6957
7058```
7159~your-urbit:talk= Hello, world!
@@ -77,7 +65,7 @@ You'll see your message printed below messages from others that came before it:
7765~your-urbit= Hello, world!
7866```
7967
80−##### Direct Messaging
68+### Direct Messaging
8169
8270To send a direct message to someone, first set your audience:
8371
@@ -97,10 +85,10 @@ Now you and `~talsur-todres` can exchange messages directly.
9785~your-urbit:talk[~talsur-todres] Hey buddy!
9886```
9987
100−To set your audience back to `/urbit-help`:
88+To set your audience back to `~dopzod/urbit-help`:
10189
10290```
103−~your-urbit:talk[~talsur-todres] ;/urbit-help
91+~your-urbit:talk[~talsur-todres] ;~dopzod/urbit-help
10492```
10593
10694You'll see your prompt change back:
@@ -109,7 +97,7 @@ You'll see your prompt change back:
10997~your-urbit:talk=
11098```
11199
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:
113101
114102```
115103~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
121109Use `;leave` to unsubscribe from a channel:
122110
123111```
124−~your-urbit:talk= ;leave /urbit-help
112+~your-urbit:talk= ;leave ~dopzod/urbit-help
125113```
126114
127115The web UI ships as compiled JavaScript on your urbit, but has its own
@@ -157,7 +145,7 @@ general use.
157145A post can be a variety of different data structures. Let's look at the
158146ones you can use from within Talk: lines, URLs, Hoon and replies.
159147
160−##### Lines
148+#### Lines
161149
162150A line is simply a string of text. Depending on the filtering rules set
163151by the circle's host, these may or may not include uppercase and Unicode
@@ -175,7 +163,7 @@ will print as
175163~your-urbit sends a message.
176164```
177165
178−##### URLs
166+#### URLs
179167
180168A URL is any valid URL.
181169
@@ -183,7 +171,7 @@ A URL is any valid URL.
183171~your-urbit:talk= https://example.com/
184172```
185173
186−##### Hoon
174+#### Hoon
187175
188176You can use Talk to evaluate Hoon code and share the result with everyone in a
189177Hall circle. To do so, preface your Hoon with `#`.
@@ -199,7 +187,7 @@ will print as
1991874
200188```
201189
202−##### Replies
190+#### Replies
203191
204192To indicate what you're saying is in direct response to a specific
205193message, 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
265253can be deleted or modified with various commands. All commands in this section
266254shoild be sent from the `talk>` prompt.
267255
268−###### Create
256+#### Create
269257
270258Syntax: `;create [type] %name 'description'`
271259
@@ -306,7 +294,7 @@ To delete our example above:
306294sampel-palnet:talk> ;delete %coolbox 'people sent uncool messages'
307295```
308296
309−###### Change Description
297+#### Change Description
310298
311299Syntax: `;depict %name 'description'`
312300
@@ -319,7 +307,7 @@ sampel-palnet:talk> ;depict %coolbox 'cool messages only. NO EXCEPTIONS.'
319307```
320308
321309<span id="filter"></span>
322−###### Filter
310+#### Filter
323311
324312Syntax: `;filter %name [capitals] [unicode]`
325313
@@ -344,7 +332,7 @@ And we get the output:
344332--------------| %coolbox: fit: caps:Y unic:n
345333```
346334
347−###### Invite
335+#### Invite
348336
349337Syntax: `;invite %name ~someone`
350338
@@ -358,7 +346,7 @@ For example:
358346~sampel-palnet:talk> ;invite %coolbox ~lodleb-ritrul
359347```
360348
361−###### Banish
349+#### Banish
362350
363351Syntax: `;banish %name ~someone`
364352
@@ -366,7 +354,7 @@ Removes someone from your circle `%name`. If they were previously invited,
366354removes them from the whitelist.
367355Can also banish multiple ships at once, `~comma, ~separated`.
368356
369−###### Source
357+#### Source
370358
371359Syntax: `;source %name ~other/circle`
372360
@@ -379,7 +367,7 @@ For example:
379367~sampel-palnet:talk> ;source %coolbox ~marzod/urbit-help
380368```
381369
382−###### Unsource
370+#### Unsource
383371
384372Syntax: `;unsource %name ~other/circle`
385373
@@ -396,14 +384,14 @@ For example:
396384If you have joined a circle, you can make this information publicly
397385available to help others find that circle as well.
398386
399−###### Show Membership
387+#### Show Membership
400388
401389Syntax: `;show ~some/circle`
402390
403391Adds a circle to your public membership list on your Hall profile. Hall profiles
404392are not used yet.
405393
406−###### Hide Membership
394+#### Hide Membership
407395
408396Syntax: `;hide ~some/circle`
409397
@@ -415,19 +403,19 @@ profiles are not used yet.
415403You'll see status notifications when people enter or leave circles you're
416404subscribed to.
417405
418−###### Notifications Off
406+#### Notifications Off
419407
420408Syntax: `;set quiet`
421409
422410Turn off status (and config) notifications.
423411
424−###### Notifications On
412+#### Notifications On
425413
426414Syntax: `;unset quiet`
427415
428416Turn on status (and config) notifications.
429417
430−###### Who
418+#### Who
431419
432420Syntax: `;who`
433421
@@ -440,7 +428,7 @@ For example:
440428~sampel-palnet:talk> ;who ~marzod/urbit-help
441429```
442430
443−###### Attend
431+#### Attend
444432
445433Syntax: `;attend ~some/circle [presence]`
446434
@@ -459,7 +447,7 @@ For example:
459447~sampel-palnet:talk> ;attend ~marzod/urbit-help idle
460448```
461449
462−###### Set Display Name
450+#### Set Display Name
463451
464452Syntax: `;name ~some/circle 'my handle'`
465453
@@ -473,7 +461,7 @@ An audience consists of one or more messaging targets. These can be
473461circles or ships. (In the latter case, it's secretly the `~ship/inbox`
474462circle.)
475463
476−#### Circle Glyphs
464+### Circle Glyphs
477465
478466Glyphs are found at the end of your prompt to as a quick indicator of where
479467your messages will be sent.
@@ -510,7 +498,7 @@ the prompt instead. Here we're talking directly to `~dannum-mitryl`:
510498~sampel-palnet:talk[~dannum-mitryl]
511499```
512500
513−###### Bind
501+#### Bind
514502
515503Syntax: `;bind [glyph] /circle-name`
516504
@@ -522,7 +510,7 @@ For example:
522510~sampel-palnet:talk> ;bind + /my-circle
523511```
524512
525−###### Unbind
513+#### Unbind
526514
527515Syntax: `;unbind [glyph] /circle-name`
528516
@@ -550,31 +538,31 @@ There are a few special-purpose glyphs:
550538
551539### Configuration
552540
553−###### Set Audience
541+#### Set Audience
554542
555543`;~ship/circle`
556544
557545Set audience to `~ship/circle`.
558546
559−###### Set Audience by Glyph
547+#### Set Audience by Glyph
560548
561549Syntax: `;[glyph]`
562550
563551Set audience to the circle previously bound to the chosen glyph.
564552
565−###### Set Audience to Ship
553+#### Set Audience to Ship
566554
567555syntax `;~ship`
568556
569557Set audience to another ship.
570558
571−###### Set Audience to Own Circle
559+#### Set Audience to Own Circle
572560
573561Syntax: `;%circle`
574562
575563Set audience to a circle on your own ship
576564
577−###### Set Audience + Send Message
565+#### Set Audience + Send Message
578566
579567Syntax: `;~dannum-mitryl this is a private message`
580568
@@ -589,44 +577,44 @@ Your audience is configured with regard to the following rules (in order):
589577
590578### Local nicknames
591579
592−###### See Nicknames
580+#### See Nicknames
593581
594582Syntax: `;nick`
595583
596584List all local nicknames.
597585
598−###### Find Nickname
586+#### Find Nickname
599587
600588Syntax: `;nick ~some-urbit`
601589
602590Look up a nickname using the known ship-name.
603591
604−###### Reverse Find Nickname
592+#### Reverse Find Nickname
605593
606594syntax: `;nick plato`
607595
608596Find a ship's name using its nickname.
609597
610−###### Set Nickname
598+#### Set Nickname
611599
612600Syntax: `;nick ~some-urbit plato`
613601
614602Create a new nickname.
615603
616−###### Clear Nickname
604+#### Clear Nickname
617605
618606Syntax: `;nick ~some-urbit ~`
619607
620608Clear an assigned nickname.
621609
622−###### Display Nicks, Not Ship-Names
610+#### Display Nicks, Not Ship-Names
623611
624612Syntax: `;set nicks`
625613
626614Show nicknames instead of ship-names. If no local nickname is set, uses
627615that user's handle. If the user has no handle, just the urbit name.
628616
629−###### Display Ship-Names, Not Nicks
617+#### Display Ship-Names, Not Nicks
630618
631619Syntax: `;unset nicks`
632620
@@ -638,38 +626,38 @@ phonebook.
638626
639627### Miscellaneous configuration
640628
641−###### Show Timestamps
629+#### Show Timestamps
642630
643631Syntax: `;set showtime`
644632
645633Show the timestamp for each message.
646634
647−###### Hide Timestamps
635+#### Hide Timestamps
648636
649637Syntax: `;unset showtime`
650638
651639Stop showing the timestamp for each message.
652640
653−###### Change Time Zone
641+#### Change Time Zone
654642
655643Syntax: `;set timezone [+/-][hours]`
656644
657645Adjust the display of the timestamps to a specific timezone. Relative to UTC.
658646
659−###### Sound Notification On
647+#### Sound Notification On
660648
661649Syntax: `;set notify`
662650
663651Emit a terminal bell sound if your six-syllable ship name is mentioned in
664652a message.
665653
666−###### Sound Notification Off
654+#### Sound Notification Off
667655
668656Syntax `;unset notify`
669657
670658Do not notify when your ship name is mentioned.
671659
672−###### Set Width
660+#### Set Width
673661
674662Syntax: `;set width [number]`
675663