aboutsummaryrefslogtreecommitdiffstats
path: root/packages/meshbay-node/src/meshbay_node/ops.py
diff options
context:
space:
mode:
authorChristophe Besson <cbesson@gmail.com>2026-09-19 02:12:47 +0200
committerChristophe Besson <cbesson@gmail.com>2026-09-19 02:12:47 +0200
commit20a824118c09af15d6c338db4c9480ffe5cbcdb6 (patch)
tree39fa0c2056b12e3423eefe0cda78cf160ce17131 /packages/meshbay-node/src/meshbay_node/ops.py
parentcc0820de8d8c33560c44bd6a0864de30e33a0109 (diff)
downloadmeshbay-20a824118c09af15d6c338db4c9480ffe5cbcdb6.tar.gz
docs: cite MESHBAY_DESIGN.md and a section instead of the merged notes
The per-feature design notes were merged into docs/MESHBAY_DESIGN.md and deleted from the tree on 2026-09-11, but ~230 comments across the three packages still named them — usually written `docs/musicbay.md §3.2`, as though the file were still in docs/. A reader had to know §16 existed to resolve any of them. They now name the section directly. Every mapping comes from §16, the concordance, which already records where each old section landed: musicbay -> §9.8, mediacenter -> §9.7 for the Videos app and §6.5 where the subject is derived data, photos -> §9.9, auth-confirm -> §3.6, refactoring-search -> §9.11, invite-pairing-v1 -> §3.4, per-node-identity-v1 -> §3.2, captcha -> §7.7, chat-sender-keys -> §4.5, apps/refactor-groups -> §9.1–§9.4, desktop-client-v1 per section. Bare citations of the same documents (`draft-v6 §2.11`, `§4.8`, `§3.4`) are retargeted too: those collide with real section numbers in the design document, so leaving them would have been worse than the named form. Four cases the concordance does not cover, each decided rather than guessed: Sub-item references into documents that no longer exist — mediacenter's `§3.3 row 4`, `§3.4b/c`, `apps.md §3b` — name rows and sub-items §9.7 and §9.2 do not reproduce. The module-level citation stays; the sub-item pointer is dropped. The V-findings keep their labels but lose the dead `§10.1/` prefix. §13.8 lists V1–V13 as per-application open items, which is not what the labels mean in these comments, so pointing them at §13.8 would have been a false citation. `apps.md §5`'s virtualization requirement has no counterpart anywhere in the design document. The requirement is stated in the comment itself, so the citation is dropped rather than aimed at a section that does not say it. Comments that attributed a *sentence* to an old note — musicbay's "several thousand files" example, its "what got measured" note, its measured ~11%/~26% cover-art figures, the "original no root, whole shared tree" call — state the fact without attribution now. §9.8 does not contain those sentences and citing it for them would have been wrong. CLAUDE.md's "a reference to a document that no longer exists" row now says the concordance is for git history and out-of-tree material; the code cites sections directly. Verified: 2851 passed, 4 skipped. The 12 errors in the run are the Firefox leg of test_sticky_header.py's browser harness, which is broken at the browser level on this machine — headless Firefox (snap) dies with `[GFX1-]: RenderCompositorSWGL failed mapping default framebuffer`, renders nothing, and the probe exits `{"error": "no measurement"}` after its full 90s wait. Chrome runs the same 12 assertions in 3.2s and passes. Nothing here can affect it: every changed line in style.css is inside a comment. Also checked: ast.parse on every changed .py, `node --check` on every changed .js, the /* */ balance in style.css, and that no changed line exceeds the width its file already used. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Diffstat (limited to 'packages/meshbay-node/src/meshbay_node/ops.py')
-rw-r--r--packages/meshbay-node/src/meshbay_node/ops.py13
1 files changed, 7 insertions, 6 deletions
diff --git a/packages/meshbay-node/src/meshbay_node/ops.py b/packages/meshbay-node/src/meshbay_node/ops.py
index 2221bea..98f67c5 100644
--- a/packages/meshbay-node/src/meshbay_node/ops.py
+++ b/packages/meshbay-node/src/meshbay_node/ops.py
@@ -283,7 +283,7 @@ async def unpin_member(state: dict, user_id: str) -> dict:
# the key, as `set_gek` does — would make every message anyone ever sent
# permanently unreadable to everybody, which is what a plain GEK-derived
# archive key would have done on the very first `member unpin`
-# (docs/chat-sender-keys.md F4).
+# (finding F4, docs/MESHBAY_DESIGN.md §13.6).
async def _wrap_for_node(state: dict, key: bytes) -> dict:
@@ -1369,7 +1369,8 @@ async def set_node_settings(state: dict, settings: dict) -> dict:
# `webrtc._stream_sem` was assigned here for months. That attribute
# has never existed -- the pool is `ctx["_transcode_sem"]` -- so the
# `hasattr` guard was always False and the setting only ever took
- # effect on a restart, which draft-v6 §2.11 says it does not need.
+ # effect on a restart, which docs/MESHBAY_DESIGN.md §6.8 says it
+ # does not need.
if webrtc is not None:
webrtc.set_capacity(
max_concurrent_streams=updated["max_concurrent_streams"])
@@ -1524,7 +1525,7 @@ async def set_tmdb_config(state: dict, token: str | None = None,
language: str | None = None) -> dict:
"""
Whether the node uses a custom API token instead of the shipped default,
- and in what language it queries TMDB (docs/mediacenter.md §5.5).
+ and in what language it queries TMDB (docs/MESHBAY_DESIGN.md §9.7).
Node-wide (roster.py group_settings, group_id="") rather than per-group
like set_enabled_apps: the token and the shared-cache
@@ -1554,8 +1555,8 @@ async def set_tmdb_config(state: dict, token: str | None = None,
async def set_tmdb_enabled(state: dict, group_id: str, enabled: bool) -> dict:
"""
- Whether TMDB lookups run for this group at all (docs/mediacenter.md
- §5.5) — per-group, unlike set_tmdb_config above: an operator running a
+ Whether TMDB lookups run for this group at all (docs/MESHBAY_DESIGN.md
+ §9.7) — per-group, unlike set_tmdb_config above: an operator running a
real media library alongside test/demo groups on one node wants
outbound TMDB traffic (and API quota) spent for the one that needs it,
not all of them just because one process serves both.
@@ -1576,7 +1577,7 @@ async def set_tmdb_enabled(state: dict, group_id: str, enabled: bool) -> dict:
async def set_musicbrainz_enabled(state: dict, group_id: str, enabled: bool) -> dict:
"""
Whether MusicBrainz lookups run for this group at all
- (docs/musicbay.md §6) — per-group from the start, same reasoning as
+ (docs/MESHBAY_DESIGN.md §9.8) — per-group from the start, same reasoning as
set_tmdb_enabled: a real media-library group and a test/demo group on
one node need not share the decision to make outbound requests.
"""