Skip to content

[AI:zf-builder] docs(openwiki): sync architecture documentation for hotcode-dev-zerohub-share - #182

Merged
ntsd merged 2 commits into
mainfrom
task/zf-z-d39dd9f0
Nov 21, 2026
Merged

ntsd merged 2 commits into
mainfrom
task/zf-z-d39dd9f0

Conversation

@ntsd

@ntsd ntsd commented Nov 21, 2026

Copy link
Copy Markdown
Contributor

[AI:zf-builder] Task: zf-z-d39dd9f0

Automated PR for task zf-z-d39dd9f0

Completed by: @zf-builder

ntsd added 2 commits November 21, 2026 06:39
Task: zf-z-d39dd9f0

docs(openwiki): sync architecture documentation for hotcode-dev-zerohub-share
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying zerohub with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0db8736
Status: ✅  Deploy successful!
Preview URL: https://16528bc4.zerohub.pages.dev
Branch Preview URL: https://task-zf-z-d39dd9f0.zerohub.pages.dev

View logs

@ntsd ntsd left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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/**/*.json files (6 claims + manifest) parse as valid JSON.
  • pageVersion is consistent for all 6 pages: .page-manifest.json == .claims/*.json == sha256 of the actual .md file (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 ✓

  1. quickstart.md — "entrypoints return Promise<void> that resolves when the signaling WebSocket opens (hub state like myPeerId/peers fills in when onHubInfo fires)": matches client/src/zeroHub.ts — all four entry points (createRandomHub, joinRandomHub, joinStaticHub, joinOrCreateIPHub) are declared Promise<void> and their docblocks state exactly this. Example calls createRandomHub({name:'Alice'}), joinRandomHub(hubId, {name:'Bob'}), joinStaticHub('my-hub', {name:'Bob'}) match the real signatures.
  2. quickstart.md — "static hubs are created out-of-band via the admin-gated /v1/static-hubs/create endpoint": matches server/pkg/handler/create_static_hub.go docblock ("created out-of-band by an admin", "requires admin").
  3. development-testing.md — "the target only generates the zerohub mock; the former hub/peer mockgen lines were removed as dead": matches the current Makefile server-mock target (single mockgen line for pkg/zerohub/zerohub.go).
  4. 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.

@ntsd
ntsd merged commit c8fe5d7 into main Nov 21, 2026
1 check passed
@ntsd
ntsd deleted the task/zf-z-d39dd9f0 branch November 21, 2026 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant