Repository navigation
docs: correct pnpm version and caller-auth count in getting-started docs - #278
Conversation
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
|
Codex review: needs real behavior proof before merge. Reviewed September 29, 2026, 9:13 PM ET / September 30, 2026, 01:13 UTC (Revision 2). ClawSweeper reviewWhat this changesThe branch changes the source-install guide from pnpm 11 to 12, changes the quickstart auth pointer from four caller methods to five, and records both corrections in the changelog. Merge readiness⛔ Blocked before merge - 2 items remain Current main still contains both outdated statements. The corrections match the package pin and authentication guide, and the PR remains useful. Priority: P3 Review scores
Verification
How this fits togetherClickClack’s getting-started docs guide contributors through building the server and finding its authentication guide. The build uses the workspace’s pinned package manager, while the server resolves incoming callers through the methods described in the auth guide. flowchart LR
A[Source checkout] --> B[Install guide]
C[Package manager pin] --> B
B --> D[Built server]
E[Incoming request] --> F[Caller identification]
F --> G[Auth guide]
G --> H[Quickstart pointer]
Before merge
Agent review detailsSecurityNone. Review metricsNone. Technical reviewBest possible solution: Keep the two onboarding statements aligned with the pinned toolchain and auth guide, with an observed check of the edited pages before merge. Do we have a high-confidence way to reproduce the issue? Not applicable as a documentation correction; the current-main docs, package pin, and auth guide establish both mismatches directly. Is this the best way to solve the issue? Yes. Changing the two stale statements is the narrowest way to align onboarding with the existing toolchain and authentication behavior. AGENTS.md: found, but no applicable review policy affected this item. Codex review notes: model internal, reasoning medium; reviewed against 31d299eee271. LabelsLabel changes: No label changes. Label justifications:
EvidenceWhat I checked:
Likely related people:
Rank-up movesOptional improvements that raise the rating; they are not merge blockers.
Rating scale
Overall follows the weaker of proof and patch quality. Workflow
HistoryReview history (1 earlier review cycle)
|
Co-authored-by: Krasimir Kralev <263465593+KrasimirKralev@users.noreply.github.com>
MUST: Allow edits from maintainers is enabled on this PR.
What Problem This Solves
Two getting-started docs state facts the code contradicts, so a new contributor following them hits a mismatch on the very first steps:
docs/install.mdtells you to use pnpm 11, but the repo pins pnpm 12.6.0 viacorepack, so a from-source setup actually runs pnpm 12.docs/quickstart.mdcalls out "the four ways to identify a caller", but ClickClack resolves callers five ways — the linked auth page and the resolver both say five.User Impact
Onboarding docs match the code: from-source instructions name the pnpm major that
corepackwill install, and the quickstart's auth pointer agrees with the auth page it links to. No behavior change — documentation only.Why This Change Was Made
corepackderives the pnpm version frompackageManagerin the rootpackage.json, which ispnpm@12.6.0.docs/development.mdalready says "pnpm 12.6.0, matchingpackageManagerinpackage.json."docs/install.mdwas left at "pnpm 11". Updated to "pnpm 12".currentActorresolves a caller through five mechanisms (Bearer session/bot token, session cookie, Cloudflare Access assertion,X-ClickClack-Userheader, dev fallback to the first user).docs/features/auth.mdopens with "ClickClack accepts five ways to identify a caller" and enumerates all five. The quickstart link that points at that page said "four" — a stale count from before Cloudflare Access was added. Updated to "five".Evidence
Grep of the current tree (
upstream/main) showing docs vs. code:Docs-only change; no code paths touched. CI's docs-site build validates the pages render.