Skip to content

Docs Readability and Accuracy - #900

Open
NNCBN wants to merge 15 commits into
nervosnetwork:developfrom
NNCBN:develop
Open

Docs Readability and Accuracy#900
NNCBN wants to merge 15 commits into
nervosnetwork:developfrom
NNCBN:develop

Conversation

@NNCBN

@NNCBN NNCBN commented Aug 17, 2026

Copy link
Copy Markdown

NNCBN added 15 commits August 17, 2026 03:36
Corrected grammatical error in the ownership responsibility section regarding asset upkeep.
Corrected a typo in the validation description for the Cell Model.
Removed Poolin link from the mining guide. Poolin Bankruptcy September 2022.
Removed the link to ViaBTC from the mining guide. viabtc discontinued the CKB pool. nervos talk: https://talk.nervos.org/t/viabtc-mining-pool-handle-any-remaining-assets-before-24-00-on-july-19-2026/10440
CKB in URL: Replace “ckb” in lowercase to resolve correctly. Note: CKB in URL is capitalized. https://minerstat.com/coin/CKB/pools
Corrected punctuation in the explanation of state rent for asset upkeep, so the punctuation isn't bolded.
Corrected grammar in the explanation of asset ownership in the Cell Model.
Clarified wording in the explanation of state rent in the Cell Model section.
repeats "also" dropping the second "also".
bitcoinlight.app by Peersyst for iOs and Android represents the future direction of the product, 

CKBull will continue operating during a transition period. Its support is expected to be phased out at a later stage, although no final date has yet been established. 
https://www.bitcoinlight.app/blog/from-ck-bull-to-bitcoin-light 
However, Bitcoin Light represents the future direction of the product, and users are encouraged to migrate in order to benefit from future updates and expanded functionality.
bitcoinlight.app by Peersyst for iOs and Android represents the future direction of the product, 

CKBull will continue operating during a transition period. Its support is expected to be phased out at a later stage, although no final date has yet been established. 
https://www.bitcoinlight.app/blog/from-ck-bull-to-bitcoin-light 
However, Bitcoin Light represents the future direction of the product, and users are encouraged to migrate in order to benefit from future updates and expanded functionality. ae4a503
@vercel

vercel Bot commented Aug 17, 2026

Copy link
Copy Markdown

@NNCBN is attempting to deploy a commit to the CKBA-2026 Team on Vercel.

A member of the Team first needs to authorize it.

@humble-little-bear

Copy link
Copy Markdown
Contributor

CKB Docs Writing Review

Summary

The grammar fixes in cell-model.md ("smart contract rules", "If a contract is exploited", "the owners are", "to ensure compliance") and mining/guide.mdx ("are covered", dropping the duplicate "also") are all correct improvements, and the pool-list cleanup (removing the discontinued ViaBTC and bankrupt Poolin, re-sorting alphabetically) checks out. However, there is a typo in the renamed wallet card ("Bitcoinl Light"), and the CKBull → Bitcoin Light rename is applied inconsistently across the site.

Findings

  • website/docs/integrate-wallets/CardContents.tsx:L20: clarity: Typo in the wallet card title: "Bitcoinl Light (formerly CKBull)". Suggest "Bitcoin Light (formerly CKBull)". [confidence: high]
  • website/docs/mining/guide.mdx:L40: consistency: The wallet is renamed to just "Bitcoin Light" here, while the wallet card in CardContents.tsx uses "Bitcoin Light (formerly CKBull)". Suggest using "Bitcoin Light (formerly CKBull)" here too, so readers who previously knew the wallet as CKBull can recognize it. [confidence: medium]

Terminology cross-checks

  • CKBull / Bitcoin Light: This PR renames the wallet in integrate-wallets/CardContents.tsx and mining/guide.mdx, but website/docs/ecosystem/EcoCardContents.tsx:L282-L292 still lists the wallet as "CKBull" with https://ckbull.app/ links. After this PR, the same product would appear under two different names and URLs on the site. Recommend updating the ecosystem card in the same PR (or a fast-follow) to keep the naming consistent.
  • minerstat URL casing: mining/guide.mdx:L72 now uses https://minerstat.com/coin/CKB/pools. Both the lowercase and uppercase variants currently resolve, so this is not a broken link — but note the existing docs are themselves inconsistent (mining/cost-and-profit.mdx uses /coin/CKB, mining/info-stats.mdx uses /coin/ckb). No action required; flagging only so the flip-flop in this PR's commit history doesn't repeat.

Questions

  • Is the plan to retire the CKBull name everywhere (including the ecosystem page and its ckbull.app links), or should the "formerly CKBull" label be kept long-term for recognition?

@humble-little-bear

Copy link
Copy Markdown
Contributor

Factual accuracy review — PR #900

All added/modified lines were checked for factual claims. Protocol-level sources (nervosnetwork/ckb, nervosnetwork/rfcs) contain no contradicting evidence; ecosystem claims were verified against first-party sources.

Verified claims (all accurate):

  • website/docs/mining/guide.mdx
    • Removal of ViaBTC from the pool list is consistent with ViaBTC's official Announcement on the Discontinuation of CKB Pool: CKB mining service ended June 29, 2026.
    • Removal of Poolin: Poolin ceased operations in 2022–2023, so the previous listing was outdated.
    • "Bitcoin Light" replacing CKBull is confirmed by the wallet's official site (bitcoinlight.app), which states it is "Formerly known as CKBull, the trusted Nervos CKB wallet." The unchanged claim that all three listed mobile wallets support Android and iOS remains consistent with the site's App Store / Google Play listings.
    • 2miners / Antpool / Binance Pool / DxPool / F2Pool entries are reordered only; their claims are unchanged.
  • website/docs/ckb-fundamentals/cell-model.md — grammar-only edits; no factual claims altered.

Minor note (non-blocking, outside factual-review scope): in website/docs/integrate-wallets/CardContents.tsx the card title reads "Bitcoinl Light (formerly CKBull)" — the first-party branding is "Bitcoin Light" (no second "l"), which is also the spelling used in guide.mdx in this same PR.

LGTM, No factual-review issues found.

@vercel

vercel Bot commented Aug 25, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
nervos-ckb-docs Ready Ready Preview Aug 25, 2026 4:55am

Request Review

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.

2 participants