Skip to content

Merge 2.61.0 into master - #943

Merged
nervos-docs-release-bot[bot] merged 5 commits into
masterfrom
develop
Sep 29, 2026
Merged

nervos-docs-release-bot[bot] merged 5 commits into
masterfrom
develop

Conversation

@nervos-docs-release-bot

Copy link
Copy Markdown
Contributor

Automated production release for v2.61.0.

@vercel

vercel Bot commented Sep 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
nervos-ckb-docs Ready Ready Preview Sep 29, 2026 9:07am UTC

Request Review

@nervos-docs-release-bot
nervos-docs-release-bot Bot merged commit d507889 into master Sep 29, 2026
4 checks passed
@humble-little-bear

Copy link
Copy Markdown
Contributor

Factual accuracy review (ckb-docs-fact-checker)

Reviewed all 12 changed Markdown/MDX files (5 example READMEs, 7 pages under website/docs/dapp/) against authoritative sources (nervosnetwork/ckb, nervosnetwork/rfcs, ckb-devrel/offckb, and the PR's own example code).

Verified claims include:

  • xUDT args format in create-token.mdx (issuer's 32-byte lock script hash + 4-byte little-endian flags 00000000; all-zero flags = no extension data, input-lock owner-mode check remains active) — matches RFC 0052 (rfcs/0052-extensible-udt/0052-extensible-udt.md, "xUDT Args" and "Owner Mode Update" sections).
  • OffCKB account key handling in _StartDevnet.mdx (private keys hidden by default; --show-private-keys flag) — matches offckb src/cli.ts (--show-private-keys, "Include built-in dev private keys (hidden by default)") and src/cmd/accounts.ts.
  • OffCKB export message File ... generated successfully. — matches offckb src/cli.ts:272.
  • Example npm scripts (start = sync:devnet + parcel, start:testnet sets NETWORK=testnet, sync:devnet, test), Devnet default when NETWORK is unset, and the sync script's behavior/messages — all match the package.json, ccc-client.ts, and scripts/sync-devnet-system-scripts.cjs changes in this PR.
  • simple-lock: nonempty-preimage validation, pnpm dev:testnet script, and deploy-time refresh/validation of all system-script entries — match frontend/app/hash-lock.ts, frontend/package.json, and scripts/deploy.js in this PR.
  • xudt tutorial UI references (prefilled first OffCKB Devnet account key, "Token xUDT args" vs Lock Script args, button labels) — match examples/dApp/xudt/index.tsx.

LGTM, No factual-review issues found.

@humble-little-bear

Copy link
Copy Markdown
Contributor

CKB Docs Writing Review

Summary

This release PR is in good editorial shape. The docs changes are net improvements: private keys are removed from the offckb accounts sample output with an accurate pointer to --show-private-keys, the Devnet/Testnet switching instructions are clearer and consistent across the example READMEs, "Behind the Scene" is fixed to "Behind the Scenes" in two tutorials, and the xUDT flags-field explanation in create-token.mdx is more precise than the old "just a placeholder" wording. Only minor polish items below.

Findings

  • create-token.mdx:L253 — clarity: "Return to the local tutorial by stopping the app and running npm start" — the reader returns to Devnet, not to the tutorial (they never left it). The shared _SwitchToTestnet.tsx phrases this as "To return to Devnet, stop the app and run npm start with NETWORK unset." Suggest aligning with that wording. [confidence: medium]
  • create-token.mdx:L68 — clarity: "...a publicly known development key included in the example code, not read from your wallet" — the trailing modifier dangles. Suggest "...included in the example code and is not read from your wallet" or splitting into two sentences. [confidence: low]
  • create-token.mdx:L240 — consistency: "a xUDT Cell" should be "an xUDT Cell" (pre-existing line, but it sits directly above a bullet this PR edits). The same page (L102, "an xUDT Script") and ecosystem-scripts/11-xudt.mdx use "an xUDT". [confidence: high]

Terminology cross-checks

  • Lock Script hash (lowercase "hash" in running text, new wording in create-token.mdx): matches existing running-text usage in ecosystem-scripts/11-xudt.mdx ("the owner Lock Script hash"). The glossary keeps the title-case heading "Lock Script Hash" as a defined term, which is fine. No change needed.
  • Devnet / Testnet / Mainnet capitalization: consistent with existing docs (_StartDevnet.mdx, sibling dapp tutorials). OK.
  • extension Scripts (capital S) in create-token.mdx:L109: consistent with 11-xudt.mdx, which capitalizes "Script" when referring to script code. OK.
  • offckb accounts --show-private-keys and the link https://github.com/ckb-devrel/offckb#accounts: verified against the offckb README — the flag exists and the #accounts anchor resolves. The description "Private keys are hidden by default" matches upstream behavior. OK.
  • pre-funded / prefilled / nonempty: hyphenation choices have no conflicting usage elsewhere in the docs corpus. OK.

Questions

  • create-token.mdx now inlines its Testnet guidance instead of using the shared <SwitchToTestnet> component that transfer-ckb.mdx and create-dob.mdx still use — presumably to add the token-specific note ("issue a new token there"). If more tutorials need page-specific Testnet notes, would it be worth giving the component a slot for extra content rather than forking the text per page?

Overall: minor polish only — nothing blocking from an editorial standpoint.

This branch was successfully deployed

1 active deployment
Preview — e99f8f28 Deployed Sep 29, 2026 by vercel[bot]
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.

3 participants