link-store: touch up interface path docs

This commit is contained in:
Fang 2020-02-07 21:43:11 +01:00
parent 2df646bd0a
commit b08a4ef605
No known key found for this signature in database
GPG Key ID: EB035760C1BBA972

View File

@ -6,28 +6,28 @@
:: primitive ui implementations. :: primitive ui implementations.
:: ::
:: urls in paths are expected to be encoded using +wood, for @ta sanity. :: urls in paths are expected to be encoded using +wood, for @ta sanity.
:: use /lib/link's +build-discussion-path. :: generally, use /lib/link's +build-discussion-path.
:: ::
:: see link-listen-hook to see what's synced in, and similarly :: see link-listen-hook to see what's synced in, and similarly
:: see link-proxy-hook to see what's exposed. :: see link-proxy-hook to see what's exposed.
:: ::
:: scry and subscription paths: :: scry and subscription paths:
:: ::
:: (map path pages) :: (map path pages) %local-pages
:: /local-pages our saved pages :: /local-pages our saved pages
:: /local-pages/some-path our saved pages on path :: /local-pages/some-path our saved pages on path
:: ::
:: (map path submissions) :: (map path submissions) %submissions
:: /submissions all submissions we've seen :: /submissions all submissions we've seen
:: /submissions/some-path all submissions we've seen on path :: /submissions/some-path all submissions we've seen on path
:: ::
:: (map path (map url notes)) :: (map path (map url notes)) %annotations
:: /annotations our comments :: /annotations our comments
:: /annotations/wood-url our comments on url :: /annotations/wood-url our comments on url
:: /annotations/wood-url/some-path our comments on url on path :: /annotations/wood-url/some-path our comments on url on path
:: /annotations//some-path our comments on path :: /annotations//some-path our comments on path
:: ::
:: (map path (map url comments)) :: (map path (map url comments)) %discussions
:: /discussions all comments :: /discussions all comments
:: /discussions/wood-url all comments on url :: /discussions/wood-url all comments on url
:: /discussions/wood-url/some-path all comments on url on path :: /discussions/wood-url/some-path all comments on url on path