Repository navigation
[AI:zf-builder] docs(openwiki): sync architecture documentation for hotcode-dev-zerohub-share - #182
Conversation
…ub-share Task: zf-z-d39dd9f0
Task: zf-z-d39dd9f0 docs(openwiki): sync architecture documentation for hotcode-dev-zerohub-share
Deploying zerohub with
|
| Latest commit: |
0db8736
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://16528bc4.zerohub.pages.dev |
| Branch Preview URL: | https://task-zf-z-d39dd9f0.zerohub.pages.dev |
ntsd
left a comment
There was a problem hiding this comment.
[AI:zf-reviewer] [Reviewer Feedback] Round 1: OpenWiki docs sync — Approved for human review
Scope (Rung 7 ✓) — git diff origin/main...HEAD --stat confirms exactly 5 files, all under openwiki/: 2 pages (quickstart.md, operations/development-testing.md), 2 matching .claims/*.json, and .page-manifest.json. No code, no lockfile churn, no drive-by reformatting, no merge-conflict residue (grep for <<<<<<</>>>>>>> clean).
Structural checks ✓
- All 7
openwiki/**/*.jsonfiles (6 claims + manifest) parse as valid JSON. pageVersionis consistent for all 6 pages:.page-manifest.json==.claims/*.json==sha256of the actual.mdfile (computed locally, all 6 match)..last-update.json:status: complete,gitHead: 6e8eced— not touched by this diff, already on main.
Content spot-checks against source ✓
quickstart.md— "entrypoints returnPromise<void>that resolves when the signaling WebSocket opens (hub state likemyPeerId/peersfills in whenonHubInfofires)": matchesclient/src/zeroHub.ts— all four entry points (createRandomHub,joinRandomHub,joinStaticHub,joinOrCreateIPHub) are declaredPromise<void>and their docblocks state exactly this. Example callscreateRandomHub({name:'Alice'}),joinRandomHub(hubId, {name:'Bob'}),joinStaticHub('my-hub', {name:'Bob'})match the real signatures.quickstart.md— "static hubs are created out-of-band via the admin-gated/v1/static-hubs/createendpoint": matchesserver/pkg/handler/create_static_hub.godocblock ("created out-of-band by an admin", "requires admin").development-testing.md— "the target only generates thezerohubmock; the formerhub/peermockgen lines were removed as dead": matches the current Makefileserver-mocktarget (singlemockgenline forpkg/zerohub/zerohub.go).- Terminology: uses the public "static hubs" term correctly (not the internal "permanent" flag) — consistent with repo convention.
Tests — docs-only PR: zero code changes, so unit/integration test coverage is not applicable; the structural checks above are the applicable gate and all pass.
Ponytail rubric — no new dependencies (Rungs 3/5 N/A), no new abstractions or speculative complexity (Rungs 1/6 N/A), minimal diff scope (Rung 7 ✓). Nothing to veto.
Mergeability — PR is CLEAN/MERGEABLE against main.
Non-blocking follow-up note (out of scope for this PR, per the openwiki-sync-only-touches-openwiki/ convention): the repo AGENTS.md "Mocking (Go)" section still says to regenerate mocks after interface changes in pkg/zerohub/zerohub.go, pkg/hub/hub.go, or pkg/peer/peer.go — stale since #153 removed the hub/peer mockgen lines. The openwiki page is correct; suggest a small AGENTS.md fix in a separate task.
GOTCHA: OpenWiki manifest structure: .page-manifest.json nests page entries under a pages key and carries no gitHead (that lives in .last-update.json as gitHead); pageVersion = sha256:<hex> of the .md file bytes, and must match the sibling .claims/<path>.json pageVersion exactly.
[AI:zf-builder] Task: zf-z-d39dd9f0
Automated PR for task zf-z-d39dd9f0
Completed by: @zf-builder