git.iko.soy/urbit.org
on master help sign in
making clearer the urbit/Urbit distinction
commitae5275f4aeb19c5cfe6310b44ab1da0257db1cad authorjoshuareagan <joshuareagan@gmail.com> dateFri 5 Oct 2018, 14:20 (8 years ago) parentf4a57c1
7 files changed+27−25
compare with master
unifiedsplit
docs/tutorials/gall/api.udon+1−1 docs/using/admin.udon+5−5 docs/using/layout.udon+4−4 docs/using/messaging.udon+2−2 docs/using/setup.udon+4−2 docs/using/shell.udon+1−1 docs/using/web.udon+10−10
docs/tutorials/gall/api.udon+1−1
@@ -147,7 +147,7 @@ are used to handle responses when we make HTTP requests.
147147That's really all there is to the reading portion of API
148148connectors.
149149
150−One of the most accessbile ways to jump into Arvo programming is
150+One of the most accessible ways to jump into Arvo programming is
151151to just add more places to an existing API connector. It's
152152useful, small in scope, and comes in bite-sized chunks since most
153153places are less than ten lines of code.
docs/using/admin.udon+5−5
@@ -19,7 +19,7 @@ You can force-quit your urbit with `Ctrl-z` from anywhere.
1919
2020## Restart
2121
22−To restart your Urbit simply pass the name of your pier:
22+To restart your urbit simply pass the name of your pier:
2323
2424```
2525$ urbit some-planet
@@ -33,7 +33,7 @@ $ urbit comet
3333
3434## Logging
3535
36−To log Urbit's command line output to a file, use `script`:
36+To log an urbit's command line output to a file, use `script`:
3737
3838```
3939$ script urbit.log urbit your-urbit
@@ -43,7 +43,7 @@ $ script urbit.log urbit your-urbit
4343
4444Piers are designed to be portable, but it _must_ be done while the urbit
4545is turned off. Urbit networking is stateful, so you can't run two copies
46−of the same Urbit in two places.
46+of the same urbit in two places.
4747
4848To move a pier, simply move the contents of the directory it lives in.
4949To keep these files as small as possible we usually use the `--sparse`
@@ -119,7 +119,7 @@ that you just started on `8081`, and so on. For planets only, we also proxy web
119119domains through Urbit's own servers. Any planet `~your-urbit` is also at
120120`your-urbit.urbit.org`.
121121
122−Your Urbit serves a simple homepage from `http://localhost:8080` or
122+Your urbit serves a simple homepage from `http://localhost:8080` or
123123`https://your-urbit.urbit.org` that should be self-explanatory. Since
124124our HTTPS isn't audited / battle tested, we just call it "secure" HTTPS.
125125You can find that on `8443`. Or `8444` (and so on) if you're already
@@ -178,7 +178,7 @@ function after we have breached, but it wont connect to the rest of the
178178Urbit network.
179179
180180When this happens, back up any files you'd like to save, shut down your
181−Urbit and recreate it (as if you were starting for the first time).
181+urbit and recreate it (as if you were starting for the first time).
182182
183183## Creating SSL certificates
184184
docs/using/layout.udon+4−4
@@ -8,13 +8,13 @@
88
99# Arvo source
1010
11−When you boot an Urbit, we transfer the current version of the Arvo
12−operating environment to your Urbit over our network. That is, the
13−source for the system lives on your Urbit. Here we'll take a brief tour
11+When you boot an urbit, we transfer the current version of the Arvo
12+operating environment to your urbit over our network. That is, the
13+source for the system lives on your urbit. Here we'll take a brief tour
1414through the structure of a base Arvo desk.
1515
1616Looking at the top level of
17−[the Arvo repo](http://github.com/urbit/arvo), or any Urbit desk that
17+[the Arvo repo](http://github.com/urbit/arvo), or any urbit desk that
1818has been mounted to unix, we see something like:
1919
2020```
docs/using/messaging.udon+2−2
@@ -17,7 +17,7 @@ For the time being come join us in `/urbit-meta` by using the
1717
1818Today, Hall is sort of like a distributed, encrypted Slack that can be
1919used from the CLI and the browser. There’s no central Hall server.
20−Any Urbit can host one.
20+Any urbit can host one.
2121
2222Hall is a general purpose tool for both aggregating and publishing
2323streams of messages. Applications can use Hall as their transport
@@ -129,7 +129,7 @@ Use `;leave` to unsubscribe from a channel:
129129~your-urbit:talk= ;leave /urbit-meta
130130```
131131
132−The web UI ships as compiled JavaScript on your Urbit, but has its own
132+The web UI ships as compiled JavaScript on your urbit, but has its own
133133source repo [here](https://github.com/urbit/talk).
134134
135135Last, let's create a channel we can invite some friends to:
docs/using/setup.udon+4−2
@@ -12,6 +12,8 @@ On disk, your urbit - also referred to as your _ship_ - is an append-only log
1212and a checkpoint. Or, in simpler terms, a directory where we keep your urbit’s
1313state. We call this a _pier_.
1414
15+> Note: we use the word 'urbit' (lowercase 'u') to indicate a particular ship, as opposed to 'Urbit' (capital 'u') to refer to the whole software stack and/or network in general.
16+
1517## Initialize
1618
1719To create a ship, we need an identity. This identity is both a network
@@ -21,7 +23,7 @@ You are probably creating one of two kinds of ships: a 32-bit _planet_
2123or a 128-bit _comet_. For a quick terminology guide and high-level
2224refresher, refer to this [handy reference sheet](../../reference/glossary/).
2325
24−If you have an Urbit invitation, you'll have a planet like
26+If you have an Urbit invitation, you'll have a planet name and ticket like
2527`~sampel-palnet` and `~sampel-sompel-simpel-sampel`. To create your
2628pier:
2729
@@ -39,7 +41,7 @@ $ urbit -w sampel-palnet -t sampel-sompel-simpel-sampel -c myplanet
3941
4042Booting may take a few minutes. Note that your planet will begin as a
4143_comet_, a wild ship drifting through cyberspace. So don't be alarmed if it
42−doesn't have the name you expected - all ships begin as such, at least for now.
44+doesn't have the name you expected -- all ships begin as such, at least for now.
4345This step exists because you need to communicate with the Urbit network to
4446authenticate your planet, and you need to have a ship of some sort to
4547communicate with the Urbit network.
docs/using/shell.udon+1−1
@@ -155,7 +155,7 @@ in the `/test` folder. Takes a path.
155155
156156##### +ticket
157157
158−Generate a ticket for an Urbit ship. Takes an Urbit name (`@p`).
158+Generate a ticket for an urbit ship. Takes an urbit name (`@p`).
159159
160160
161161```
docs/using/web.udon+10−10
@@ -11,7 +11,7 @@
1111;div(class "row")
1212 ;div(class "col-md-8")
1313
14−Your Urbit runs its own webserver, Eyre, that handles all things HTTP. Here
14+Your urbit runs its own webserver, Eyre, that handles all things HTTP. Here
1515we'll cover the features of Eyre that most resemble a traditional web server.
1616
1717By default Eyre uses *Tree*. Tree is a simple ui for browsing the contents of
@@ -23,7 +23,7 @@ Tree was built primarily to display both our documentation and the contents of
2323checking out the [docs source](https://github.com/urbit/docs) and the
2424[urbit.org](https://github.com/urbit/urbit.org) source.
2525
26−We ship `tree` as compiled JavaScript on your Urbit, but the source lives in its
26+We ship `tree` as compiled JavaScript on your urbit, but the source lives in its
2727own repo [here](https://github.com/urbit/tree).
2828
2929 ==
@@ -149,7 +149,7 @@ your heart's content.
149149
150150## `/web`
151151
152−This is the equivalent of a `public_html` directory. Your Urbit looks in this
152+This is the equivalent of a `public_html` directory. Your urbit looks in this
153153directory to serve content to the world. You can change what desk you're serving from using `|serve`.
154154
155155Switch to the `%sandbox` desk:
@@ -180,7 +180,7 @@ Let's quickly step through the default contents of `web/`:
180180
181181## Tree
182182
183−Tree is a simple publishing tool for files that live on your Urbit. You're
183+Tree is a simple publishing tool for files that live on your urbit. You're
184184probably reading this file using Tree right now. The main driving use-case for
185185Tree has been for us to host our own documentation and the surrounding
186186discussion. Tree remains a pretty simple and flexible tool for getting content
@@ -197,7 +197,7 @@ a slightly modifed version of [Bootstrap](http://getbootstrap.com/). On your
197197Urbit Tree is a renderer that translates data in `%clay`, our filesystem, into
198198JSON / JSX that can be read by the client.
199199
200−Your Urbit comes with a pre-built copy of the tree (as a single `.js` file). If
200+Your urbit comes with a pre-built copy of the tree (as a single `.js` file). If
201201you're interested in helping to develop tree or learning about how it works, it
202202has its own GitHub repo [here](https://github.com/urbit/tree). We have our own
203203fork of Bootstrap, which lives [here](https://github.com/urbit/bootstrap).
@@ -405,18 +405,18 @@ The `<talk>` component isn't a part of Tree — it's loaded first before it's
405405executed.
406406
407407If you're interested in seeing how a module works you can check out the source
408−for Talk [here](https://github.com/urbit/talk). Dojo also ships on your Urbit,
408+for Talk [here](https://github.com/urbit/talk). Dojo also ships on your urbit,
409409its source is [here](https://github.com/urbit/sole).
410410
411411## `urb.js`
412412
413−The most basic interface between your browser and your Urbit is `urb.js`. This
413+The most basic interface between your browser and your urbit is `urb.js`. This
414414small library provides the basic utilities for sending and receiving messages
415−from an Urbit.
415+from an urbit.
416416
417417### `window.urb.appl`
418418
419−Each JSON message sent to your Urbit needs an app endpoint. Can be set as a
419+Each JSON message sent to your urbit needs an app endpoint. Can be set as a
420420global `window.urb.appl` or set on a per-request basis in the payload to
421421`send()`.
422422
@@ -428,7 +428,7 @@ Required part of any authenticated request and included by default.
428428### `window.urb.req(method,url,params,json,cb)`
429429
430430Our basic request wrapper. You can see here how a request needs to be packaged
431−to be properly understood by your Urbit.
431+to be properly understood by your urbit.
432432
433433### `window.urb.subscribe({path:"string"})`
434434