on master help sign in
Merge pull request #254 from keatondunsford/patch-1

rmariani Patch 1

commitb1906925ed26ca71cfd834f13f7f36268b8b501a authorKeaton Dunsford <keaton.dunsford@gmail.com> dateThu 26 Apr 2018, 17:05 (9 years ago) parentf977d2a5448ba9
2 files changed+7−7
docs/hall/architecture.md+1−1 docs/hall/interface.md+6−6
docs/hall/architecture.md+1−1
@@ -10,7 +10,7 @@ title: Hall architecture
1010
1111This document is complemented by Hall's source code, but doesn't require it. Definitions of data structures, code snippets and diagrams will be provided where useful.
1212
13−Hall's implementation is structured according to the new Gall model. Familiarity with its concepts is assumed. See [the new Gall model](../new-gall).
13+Hall's implementation is structured according to the new Gall model. Familiarity with its concepts is assumed. See [the new Gall model](new-gall).
1414
1515## Table of contents
1616
docs/hall/interface.md+6−6
@@ -8,7 +8,7 @@ title: Hall interface
88
99# Hall interface
1010
11−This document describes the different interfaces Hall provides and the data that is accessible and modifyable through them. Knowledge of the Urbit application model (including [new gall](gall.md)) and #[Hall's architecture](architecture.md) is assumed.
11+This document describes the different interfaces Hall provides and the data that is accessible and modifiable through them. Knowledge of the Urbit application model (including [new gall](new-gall)) and [Hall's architecture](architecture) is assumed.
1212
1313While the structures here are given in Hoon, they match fairly closely to their JSON equivalent. Most important to note is that `$%({$x y/z})` becomes accessible as `json.x.y`.
1414
@@ -75,7 +75,7 @@ Contains a map of glyphs and the audiences they map to, as well as a map of ship
7575
7676#### /client rumor
7777
78−Contains either a bound or unbound glyph and its target, or a ship with its new ncikname. A `nic`kname of `''` means the associated ship no longer has a nickname set for it.
78+Contains either a bound or unbound glyph and its target, or a ship with its new nickname. A nickname of `''` means the associated ship no longer has a nickname set for it.
7979
8080```
8181++ rumor :> query result change
@@ -179,9 +179,9 @@ Contains a ship and a query, and a flag to indicate whether that subscription ha
179179
180180### /circle
181181
182−Circle queries allow for the retrieving of data from stories. Their messages, configuration, presences, can all be accessed. Since this is a lot of data, there are lots of possibilities for filtering it built in to the query itself.
182+Circle queries allow for the retrieving of data from stories. Their messages, configuration, and presences can all be accessed. Since this is a lot of data, there are lots of possibilities for filtering it built in to the query itself.
183183
184−A quick refresher on the difference between "local" and "remote" presence and configuration: "local" means it pertains to the circle itself, "remote" means it pertains to one of its configured sources. The latter is primarily useful to clients when using a circle for aggregation, like the `%inbox`.
184+A quick refresher on the difference between "local" and "remote" presence and configuration: "local" means it pertains to the circle itself; "remote" means it pertains to one of its configured sources. The latter is primarily useful to clients when using a circle for aggregation, like the `%inbox`.
185185
186186```
187187++ query ::
@@ -245,7 +245,7 @@ Valid paths include:
245245
246246#### /circle prize
247247
248−Contains (where applicable) messages in envelopes (with message numbers), local and remote configurations and presences.
248+Contains (where applicable) messages in envelopes (with message numbers), as well as local and remote configurations and presences.
249249
250250```
251251++ prize :> query result
@@ -377,7 +377,7 @@ When the user makes any changes to shared UI elements (elements that should pers
377377```
378378
379379
380−`%glyph`: Adds or removed a binding of a glyph to an audience.
380+`%glyph`: Adds or removes a binding of a glyph to an audience.
381381
382382`%nick`: Sets a local nickname for a ship. An empty nickname `''` means the ship has no nickname.
383383