aboutsummaryrefslogtreecommitdiffstats
path: root/packages/meshbay-common/src/meshbay_common/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'packages/meshbay-common/src/meshbay_common/__init__.py')
-rw-r--r--packages/meshbay-common/src/meshbay_common/__init__.py25
1 files changed, 13 insertions, 12 deletions
diff --git a/packages/meshbay-common/src/meshbay_common/__init__.py b/packages/meshbay-common/src/meshbay_common/__init__.py
index c5b0279..1d857fd 100644
--- a/packages/meshbay-common/src/meshbay_common/__init__.py
+++ b/packages/meshbay-common/src/meshbay_common/__init__.py
@@ -26,7 +26,8 @@ __version__ = "0.14.0"
# older client simply never sends/handles the new pair.
# 0.8: added `artist`/`album`/`track_no` to `IndexEntry`, and
# `musicbrainz_config`/`_ack`, `musicbrainz_enabled`/`_ack`,
-# `music_meta_req`/`_resp`, for the Music group app (docs/musicbay.md).
+# `music_meta_req`/`_resp`, for the Music group app
+# (docs/MESHBAY_DESIGN.md §9.8).
# Same shape as 0.5-0.7's Videos additions, and reuses `duration`/
# `thumb_hash`/`display_title` rather than declaring new ones. Additive:
# an older client simply doesn't render the new fields or send the new
@@ -38,29 +39,29 @@ __version__ = "0.14.0"
# client never sends the request, and simply can't play those two formats,
# same as before this existed.
# 0.10: added `audio_root`/`_ack` — the Music app's own entry point, same
-# shape as `video_root`/`_ack`. Reverses musicbay.md's original "no root,
-# whole shared tree" call: a real messy library showed that call was
-# wrong, and Music now requires one before showing/enriching anything,
-# exactly like Videos. Additive at the protocol level: an older client
-# never sends the op and never expects the field.
+# shape as `video_root`/`_ack`. Reverses the original "no root, whole
+# shared tree" call: a real messy library showed that call was wrong, and
+# Music now requires one before showing/enriching anything, exactly like
+# Videos (docs/MESHBAY_DESIGN.md §9.8). Additive at the protocol level: an
+# older client never sends the op and never expects the field.
# 0.11: added `taken_at`/`camera` to `IndexEntry` (best-effort, from a photo's
# own EXIF block) and `photo_roots`/`photo_roots_ack`, for the Photos group
-# app (docs/photos.md). Unlike `video_root`/`audio_root`, `photo_roots` is a
-# *set*, replaced whole in one signed op — a photo library is routinely
-# scattered across several folders, not one. Additive: an older client
+# app (docs/MESHBAY_DESIGN.md §9.9). Unlike `video_root`/`audio_root`,
+# `photo_roots` is a *set*, replaced whole in one signed op — a photo library
+# is routinely scattered across several folders, not one. Additive: an older client
# never sends the op and never expects either field.
# 0.12: added `link_preview_req`/`link_preview_resp` — the node unfurls a URL
# pasted in chat into an OpenGraph card. Additive: an older node logs "unknown
# type" and the client just shows the bare link, as it always did.
# 0.13: added `tmdb_rematch`/`tmdb_rematch_ack` — an operator dropping one
# file's cached TMDB match so it re-resolves with the current matcher
-# (§10.1/V13). Additive: an older node logs "unknown type", the client's
+# (V13). Additive: an older node logs "unknown type", the client's
# button just does nothing.
# 0.14: added an optional `bundle_enc_recovery` field on `keypair_bundle_store`
# and `keypair_bundle_resp` — a second copy of the identity bundle wrapped
# under the account's recovery key, so a forgotten passphrase does not strand
-# the identity (docs/auth-confirm.md §4.3). Additive: an older node ignores the
-# field on store and never returns one; an older client never sends it.
+# the identity (docs/MESHBAY_DESIGN.md §3.6). Additive: an older node ignores
+# the field on store and never returns one; an older client never sends it.
# 0.15: `file_chunk` and `index_sync` had forked between the transports — WebRTC
# sent binary, unsigned chunks and plain index entries, QUIC sent base64 chunks
# with a per-chunk Ed25519 signature and a `GroupIndex.serialize()` envelope. One