diff --git a/pkg/arvo/app/chat-hook.hoon b/pkg/arvo/app/chat-hook.hoon index fc8d546ec8..e6aa7e2e5e 100644 --- a/pkg/arvo/app/chat-hook.hoon +++ b/pkg/arvo/app/chat-hook.hoon @@ -1,4 +1,4 @@ -:: chat-hook: +:: chat-hook [landscape]: :: mirror chat data from foreign to local based on read permissions :: allow sending chat messages to foreign paths based on write perms :: @@ -114,7 +114,7 @@ i.syncs ?> ?=(^ pax) ?. =('~' i.pax) - $(syncs t.syncs) + $(syncs t.syncs) =/ new-path=path t.pax =. synced.old diff --git a/pkg/arvo/app/chat-store.hoon b/pkg/arvo/app/chat-store.hoon index 3004a1c5ff..5118babbcc 100644 --- a/pkg/arvo/app/chat-store.hoon +++ b/pkg/arvo/app/chat-store.hoon @@ -1,4 +1,6 @@ -:: chat-store: data store that holds linear sequences of chat messages +:: chat-store [landscape]: +:: +:: data store that holds linear sequences of chat messages :: /+ store=chat-store, default-agent, verb, dbug, group-store ~% %chat-store-top ..is ~ diff --git a/pkg/arvo/app/chat-view.hoon b/pkg/arvo/app/chat-view.hoon index 15b7bdf403..054c702403 100644 --- a/pkg/arvo/app/chat-view.hoon +++ b/pkg/arvo/app/chat-view.hoon @@ -1,4 +1,6 @@ -:: chat-view: sets up chat JS client, paginates data, and combines commands +:: chat-view [landscape]: +:: +:: sets up chat JS client, paginates data, and combines commands :: into semantic actions for the UI :: /- *permission-store, @@ -157,7 +159,7 @@ (on-arvo:def wire sign-arvo) :: ++ on-save !>(state) - ++ on-load + ++ on-load |= old-vase=vase ^- (quip card _this) =/ old ((soft state-0) q.old-vase) @@ -212,8 +214,8 @@ ?- -.act %create ?> ?=(^ app-path.act) - ?> ?| =(+:group-path.act app-path.act) - =(~(tap in members.act) ~) + ?> ?| =(+:group-path.act app-path.act) + =(~(tap in members.act) ~) == ?^ (chat-scry app-path.act) ~& %chat-already-exists diff --git a/pkg/arvo/app/clock.hoon b/pkg/arvo/app/clock.hoon index 74af060986..c4db5f62de 100644 --- a/pkg/arvo/app/clock.hoon +++ b/pkg/arvo/app/clock.hoon @@ -1,4 +1,6 @@ -:: clock: deprecated, should be removed +:: clock [landscape]: +:: +:: deprecated, should be removed :: /+ *server, default-agent, verb, dbug =, format diff --git a/pkg/arvo/app/contact-hook.hoon b/pkg/arvo/app/contact-hook.hoon index acb3b95724..4bc66de485 100644 --- a/pkg/arvo/app/contact-hook.hoon +++ b/pkg/arvo/app/contact-hook.hoon @@ -1,4 +1,5 @@ -:: contact-hook: +:: contact-hook [landscape] +:: :: /- group-hook, *contact-hook, @@ -54,7 +55,7 @@ =/ old !<(versioned-state old-vase) =| cards=(list card) |^ - |- ^- (quip card _this) + |- ^- (quip card _this) ?: ?=(%3 -.old) [cards this(state old)] ?: ?=(%2 -.old) @@ -80,7 +81,7 @@ %_ $ -.old %2 :: - synced.old + synced.old %- malt %+ turn ~(tap by synced.old) @@ -126,7 +127,7 @@ %json (poke-json:cc !<(json vase)) :: - %contact-action + %contact-action (poke-contact-action:cc !<(contact-action vase)) :: %contact-hook-action @@ -149,7 +150,7 @@ %kick [(kick:cc wire) this] %watch-ack =^ cards state - (watch-ack:cc wire p.sign) + (watch-ack:cc wire p.sign) [cards this] :: %fact @@ -301,8 +302,8 @@ [%pass /group %agent [our.bol %group-store] %watch /groups]~ :: [%contacts @ *] - =/ wir - ?: =(%ship i.t.wir) + =/ wir + ?: =(%ship i.t.wir) wir (migrate wir) ?> ?=([%contacts @ @ *] wir) diff --git a/pkg/arvo/app/contact-store.hoon b/pkg/arvo/app/contact-store.hoon index 50b6f9cfb7..6089cae80c 100644 --- a/pkg/arvo/app/contact-store.hoon +++ b/pkg/arvo/app/contact-store.hoon @@ -1,4 +1,6 @@ -:: contact-store: data store that holds group-based contact data +:: contact-store [landscape]: +:: +:: data store that holds group-based contact data :: /+ *contact-json, default-agent, dbug |% @@ -253,7 +255,7 @@ ++ send-diff |= [pax=path upd=contact-update] ^- (list card) - :~ :* + :~ :* %give %fact ~[/all /updates [%contacts pax]] %contact-update !>(upd) diff --git a/pkg/arvo/app/contact-view.hoon b/pkg/arvo/app/contact-view.hoon index 417b754524..9fab4648c8 100644 --- a/pkg/arvo/app/contact-view.hoon +++ b/pkg/arvo/app/contact-view.hoon @@ -1,4 +1,6 @@ -:: contact-view: sets up contact JS client and combines commands +:: contact-view [landscape]: +:: +:: sets up contact JS client and combines commands :: into semantic actions for the UI :: /- diff --git a/pkg/arvo/app/file-server.hoon b/pkg/arvo/app/file-server.hoon index 7969a37296..ddeb7b3d90 100644 --- a/pkg/arvo/app/file-server.hoon +++ b/pkg/arvo/app/file-server.hoon @@ -1,3 +1,7 @@ +:: file-server [landscape]: +:: +:: mounts HTTP endpoints for Landscape (and third-party) user applications +:: /- srv=file-server, glob /+ *server, default-agent, verb, dbug |% @@ -218,8 +222,8 @@ :: [~ %html] %. file - %* . html-response:gen - cache + %* . html-response:gen + cache !=(/app/landscape/index/html (slag 3 scry-path)) == == diff --git a/pkg/arvo/app/glob.hoon b/pkg/arvo/app/glob.hoon index cdaff45f24..dc1ae6e083 100644 --- a/pkg/arvo/app/glob.hoon +++ b/pkg/arvo/app/glob.hoon @@ -1,3 +1,7 @@ +:: glob [landscape]: +:: +:: prompts content delivery and Gall state storage for Landscape JS blob +:: /- glob /+ default-agent, verb, dbug |% diff --git a/pkg/arvo/app/graph-store.hoon b/pkg/arvo/app/graph-store.hoon index ab9a6b9710..8197f439ab 100644 --- a/pkg/arvo/app/graph-store.hoon +++ b/pkg/arvo/app/graph-store.hoon @@ -1,3 +1,6 @@ +:: graph-store [landscape] +:: +:: /+ store=graph-store, sigs=signatures, res=resource, default-agent, dbug ~% %graph-store-top ..is ~ |% @@ -282,7 +285,7 @@ ?~ index graph =* atom i.index =/ =node:store - ~| "node does not exist to add signatures to!" + ~| "node does not exist to add signatures to!" (need (get:orm graph atom)) :: last index in list :: @@ -327,7 +330,7 @@ ?~ index graph =* atom i.index =/ =node:store - ~| "node does not exist to add signatures to!" + ~| "node does not exist to add signatures to!" (need (get:orm graph atom)) :: last index in list :: @@ -525,7 +528,7 @@ =/ update-log=(unit update-log:store) (~(get by update-logs) [ship term]) ?~ update-log [~ ~] =/ result=(unit [time update:store]) - (peek:orm-log:store u.update-log) + (peek:orm-log:store u.update-log) ?~ result [~ ~] ``noun+!>([~ -.u.result]) == diff --git a/pkg/arvo/app/group-hook.hoon b/pkg/arvo/app/group-hook.hoon index 4b2d7a2204..5a29752e35 100644 --- a/pkg/arvo/app/group-hook.hoon +++ b/pkg/arvo/app/group-hook.hoon @@ -1,4 +1,6 @@ -:: group-hook: allow syncing group data from foreign paths to local paths +:: group-hook [landscape]: +:: +:: allow syncing group data from foreign paths to local paths :: /- *group, hook=group-hook, *invite-store /+ default-agent, verb, dbug, store=group-store, grpl=group, pull-hook, push-hook, resource @@ -58,7 +60,7 @@ :: ignore duplicate publish groups ?: =(4 (lent path)) ~& "ignoring: {}" - ~ + ~ =/ pax=^path ?: =('~' i.path) t.path diff --git a/pkg/arvo/app/group-pull-hook.hoon b/pkg/arvo/app/group-pull-hook.hoon index 5a8c639c13..4d6da63891 100644 --- a/pkg/arvo/app/group-pull-hook.hoon +++ b/pkg/arvo/app/group-pull-hook.hoon @@ -1,5 +1,6 @@ -:: group-hook: allow syncing group data from foreign paths to local paths +:: group-hook [landscape]: :: +:: allow syncing group data from foreign paths to local paths :: /- *group, hook=group-hook, *invite-store, *resource /+ default-agent, verb, dbug, store=group-store, grpl=group, pull-hook diff --git a/pkg/arvo/app/group-push-hook.hoon b/pkg/arvo/app/group-push-hook.hoon index 443889e883..7e5215fa02 100644 --- a/pkg/arvo/app/group-push-hook.hoon +++ b/pkg/arvo/app/group-push-hook.hoon @@ -1,5 +1,6 @@ -:: group-hook: allow syncing group data from foreign paths to local paths +:: group-hook [landscape]: :: +:: allow syncing group data from foreign paths to local paths :: /- *group, hook=group-hook, *invite-store /+ default-agent, verb, dbug, store=group-store, grpl=group, push-hook, diff --git a/pkg/arvo/app/group-store.hoon b/pkg/arvo/app/group-store.hoon index bec2254017..57552866af 100644 --- a/pkg/arvo/app/group-store.hoon +++ b/pkg/arvo/app/group-store.hoon @@ -1,4 +1,6 @@ -:: group-store: Store groups of ships +:: group-store [landscape]: +:: +:: Store groups of ships :: :: group-store stores groups of ships, so that resources in other apps can be :: associated with a group. The current model of group-store rolls @@ -128,7 +130,7 @@ ^- [resource group] =/ members=(set ship) (~(got by groups.old) pax) - =| =invite:policy + =| =invite:policy ?> ?=(^ pax) =/ rid=resource (resource-from-old-path t.pax) @@ -149,7 +151,7 @@ |= pax=path =/ members (~(got by groups.old) pax) - =| =invite:policy + =| =invite:policy =/ rid=resource (resource-from-old-path pax) =/ =tags @@ -239,7 +241,7 @@ (~(has in members.group) ship) == %open - ?! ?| + ?! ?| (~(has in banned.policy) ship) (~(has in ban-ranks.policy) (clan:title ship)) == @@ -285,7 +287,7 @@ ^- resource ?> ?=([@ @ *] path) :- (slav %p i.path) - i.t.path + i.t.path :: ++ add-new |= =permission:permission-store @@ -293,7 +295,7 @@ ?: ?=(%black kind.permission) [~ ~ [%open ~ who.permission] %.y] [who.permission ~ [%invite ~] %.y] - :: + :: ++ update-existing |= =permission:permission-store |= =group diff --git a/pkg/arvo/app/invite-hook.hoon b/pkg/arvo/app/invite-hook.hoon index 2e4cef97b9..0e7b93d97a 100644 --- a/pkg/arvo/app/invite-hook.hoon +++ b/pkg/arvo/app/invite-hook.hoon @@ -1,4 +1,6 @@ -:: invite-hook: receive invites from any source +:: invite-hook [landscape]: +:: +:: receive invites from any source :: :: only handles %invite actions. accepts json, but only from the host team. :: can be poked by the host team to send an invite out to someone. diff --git a/pkg/arvo/app/invite-store.hoon b/pkg/arvo/app/invite-store.hoon index f08bb6cbf4..c09bd4cbae 100644 --- a/pkg/arvo/app/invite-store.hoon +++ b/pkg/arvo/app/invite-store.hoon @@ -1,3 +1,4 @@ +:: invite-store [landscape] /+ *invite-json, default-agent, dbug |% +$ card card:agent:gall diff --git a/pkg/arvo/app/invite-view.hoon b/pkg/arvo/app/invite-view.hoon index 666ed54730..72f3a0cc5a 100644 --- a/pkg/arvo/app/invite-view.hoon +++ b/pkg/arvo/app/invite-view.hoon @@ -1,3 +1,7 @@ +:: invite-view [landscape]: +:: +:: deprecated +:: /+ default-agent ^- agent:gall |_ =bowl:gall diff --git a/pkg/arvo/app/launch.hoon b/pkg/arvo/app/launch.hoon index 2eb3b3e675..ee0b23964b 100644 --- a/pkg/arvo/app/launch.hoon +++ b/pkg/arvo/app/launch.hoon @@ -1,3 +1,7 @@ +:: launch [landscape]: +:: +:: registers Landscape (and third party) applications, tiles +:: /+ store=launch-store, default-agent, dbug |% +$ card card:agent:gall diff --git a/pkg/arvo/app/link-listen-hook.hoon b/pkg/arvo/app/link-listen-hook.hoon index 9fae8d98b7..8fe602d2d8 100644 --- a/pkg/arvo/app/link-listen-hook.hoon +++ b/pkg/arvo/app/link-listen-hook.hoon @@ -1,4 +1,6 @@ -:: link-listen-hook: get your friends' bookmarks +:: link-listen-hook [landscape]: +:: +:: get your friends' bookmarks :: :: keeps track of a listening=(set app-path). users can manually add to and :: remove from this set. @@ -118,7 +120,7 @@ /app-indices == |- - ?~ resources + ?~ resources upgrade-loop(old [%2 +.old]) =, i.resources =/ members=(set ship) diff --git a/pkg/arvo/app/link-proxy-hook.hoon b/pkg/arvo/app/link-proxy-hook.hoon index 98f61f6f8c..4d325e11fc 100644 --- a/pkg/arvo/app/link-proxy-hook.hoon +++ b/pkg/arvo/app/link-proxy-hook.hoon @@ -1,4 +1,6 @@ -:: link-proxy-hook: make local pages available to foreign ships +:: link-proxy-hook [landscape]: +:: +:: make local pages available to foreign ships :: :: this is a "proxy" style hook, relaying foreign subscriptions into local :: stores if permission conditions are met. diff --git a/pkg/arvo/app/link-store.hoon b/pkg/arvo/app/link-store.hoon index fed3d1206a..8fe1c54a25 100644 --- a/pkg/arvo/app/link-store.hoon +++ b/pkg/arvo/app/link-store.hoon @@ -1,4 +1,6 @@ -:: link: social bookmarking +:: link [landscape]: +:: +:: social bookmarking :: :: the paths under which links are submitted are generally expected to :: correspond to existing group paths. for strictly-local collections of diff --git a/pkg/arvo/app/link-view.hoon b/pkg/arvo/app/link-view.hoon index eaeefae07c..3487e4e92d 100644 --- a/pkg/arvo/app/link-view.hoon +++ b/pkg/arvo/app/link-view.hoon @@ -1,4 +1,6 @@ -:: link-view: frontend endpoints +:: link-view [landscape]: +:: +::frontend endpoints :: :: endpoints, mapping onto link-store's paths. p is for page as in pagination. :: only the /0/submissions endpoint provides updates. diff --git a/pkg/arvo/app/metadata-hook.hoon b/pkg/arvo/app/metadata-hook.hoon index e3acbd0129..5cad893191 100644 --- a/pkg/arvo/app/metadata-hook.hoon +++ b/pkg/arvo/app/metadata-hook.hoon @@ -1,4 +1,6 @@ -:: metadata-hook: allow syncing foreign metadata +:: metadata-hook [landscape]: +:: +:: allow syncing foreign metadata :: :: watch paths: :: /group/%group-path all updates related to this group @@ -37,7 +39,7 @@ [[%pass /updates %agent [our.bowl %metadata-store] %watch /updates]~ this] :: ++ on-save !>(state) - ++ on-load + ++ on-load |= =vase =/ old !<(versioned-state vase) diff --git a/pkg/arvo/app/metadata-store.hoon b/pkg/arvo/app/metadata-store.hoon index a0e88e2e6d..0a6c52db6e 100644 --- a/pkg/arvo/app/metadata-store.hoon +++ b/pkg/arvo/app/metadata-store.hoon @@ -1,4 +1,6 @@ -:: metadata-store: data store for application metadata and mappings +:: metadata-store [landscape]: +:: +:: data store for application metadata and mappings :: between groups and resources within applications :: :: group-paths are expected to be an existing group path diff --git a/pkg/arvo/app/permission-group-hook.hoon b/pkg/arvo/app/permission-group-hook.hoon index 266666a8c0..535b54caf7 100644 --- a/pkg/arvo/app/permission-group-hook.hoon +++ b/pkg/arvo/app/permission-group-hook.hoon @@ -1,4 +1,6 @@ -:: permission-group-hook: groups into permissions +:: permission-group-hook [landscape]: +:: +:: groups into permissions :: :: mirror the ships in specified groups to specified permission paths :: diff --git a/pkg/arvo/app/permission-hook.hoon b/pkg/arvo/app/permission-hook.hoon index 7c55bdc682..ba715b64c5 100644 --- a/pkg/arvo/app/permission-hook.hoon +++ b/pkg/arvo/app/permission-hook.hoon @@ -1,4 +1,6 @@ -:: permission-hook: mirror remote permissions +:: permission-hook [landscape]: +:: +:: mirror remote permissions :: :: allows mirroring permissions between local and foreign ships. :: local permission path are exposed according to the permssion paths diff --git a/pkg/arvo/app/permission-store.hoon b/pkg/arvo/app/permission-store.hoon index be9b2923e6..0d051aac75 100644 --- a/pkg/arvo/app/permission-store.hoon +++ b/pkg/arvo/app/permission-store.hoon @@ -1,4 +1,6 @@ -:: permission-store: track black- and whitelists of ships +:: permission-store [landscape]: +:: +:: track black- and whitelists of ships :: /- *permission-store /+ default-agent, verb, dbug diff --git a/pkg/arvo/app/pool-group-hook.hoon b/pkg/arvo/app/pool-group-hook.hoon index 74e9385d32..e858112c55 100644 --- a/pkg/arvo/app/pool-group-hook.hoon +++ b/pkg/arvo/app/pool-group-hook.hoon @@ -1,4 +1,6 @@ -:: pool-group-hook: maintain groups based on invite pool +:: pool-group-hook [landscape]: +:: +:: maintain groups based on invite pool :: :: looks at our invite tree, adds our siblings to group at +group-path :: diff --git a/pkg/arvo/app/publish.hoon b/pkg/arvo/app/publish.hoon index 00b5075bfb..2ec74fb1ca 100644 --- a/pkg/arvo/app/publish.hoon +++ b/pkg/arvo/app/publish.hoon @@ -1,3 +1,7 @@ +:: publish [landscape] +:: +:: stores notebooks in clay, subscribes and allow subscriptions to notebooks +:: /- *publish /- *group /- group-hook diff --git a/pkg/arvo/app/s3-store.hoon b/pkg/arvo/app/s3-store.hoon index 390ae8e7ff..5b0bf0c70c 100644 --- a/pkg/arvo/app/s3-store.hoon +++ b/pkg/arvo/app/s3-store.hoon @@ -1,3 +1,7 @@ +:: s3-store [landscape]: +:: +:: stores s3 keys for uploading and sharing images and objects +:: /- *s3 /+ s3-json, default-agent, verb, dbug ~% %s3-top ..is ~ diff --git a/pkg/arvo/app/soto.hoon b/pkg/arvo/app/soto.hoon index 98645dafde..2ca0c26202 100644 --- a/pkg/arvo/app/soto.hoon +++ b/pkg/arvo/app/soto.hoon @@ -1,5 +1,6 @@ :: -:: Soto: A Dojo relay for Urbit's Landscape interface +:: soto [landscape]: A Dojo relay for Urbit's Landscape interface +:: :: Relays sole-effects to subscribers and forwards sole-action pokes :: /- sole diff --git a/pkg/arvo/app/weather.hoon b/pkg/arvo/app/weather.hoon index 9c07b0faec..684956b151 100644 --- a/pkg/arvo/app/weather.hoon +++ b/pkg/arvo/app/weather.hoon @@ -1,3 +1,7 @@ +:: weather [landscape]: +:: +:: holds latlong, gets weather data from API, passes it on to subscribers +:: /+ *server, default-agent, verb, dbug =, format ::