Spark Program | CKB Developer Onboarding Guide

English
,
15

Hello @xingtianchunyan, here is the report for Week 1 (overall week 3) Milestone 2

Week 1 Milestone 2 Progress Report

Status

Milestone 1 has been completed.

Milestone 2 has started, and the Week 1 scope has been completed in the local repository workspace.

Work Completed

1. First CKB-Specific Overview Layer Added

The existing document at docs/03-quick-start.md was repurposed to fit the current repository structure and now works as the first CKB-specific overview layer.

This section now explains:

  • what CKB is

  • what Nervos is

  • what role a CKB node plays

  • what RPC is

  • why a developer may use a local node or a public RPC endpoint

  • what the guide currently covers and does not yet cover

This was done without creating duplicate files or breaking the Milestone 1 document ordering.

2. CKB Node Setup Guidance Expanded

The existing document at docs/04-ckb-node-setup.md was expanded from a narrower setup page into a more practical onboarding decision guide.

The updated section now covers:

  • when a local node is needed

  • when a public or shared RPC endpoint may be enough

  • the repository-validated local setup path

  • high-level preparation before local node work

  • common beginner mistakes

  • a verification checklist

Where the repository does not already contain validated evidence for exact broader setup instructions, the page now marks those areas for later verification against official CKB documentation.

3. RPC Basics Documentation Added In The Existing RPC Section

The existing document at docs/05-rpc-setup.md was expanded and reframed as an RPC basics page while keeping the current file structure intact.

The updated section now explains:

  • what RPC means

  • why RPC matters in CKB development

  • the difference between local RPC and public RPC

  • the health-check concept used during onboarding

  • what a successful response means

  • what failure usually means

4. Local Checkpoint Guidance Folded Into The Existing Milestone 2 Flow

Instead of creating a new top-level numbered document, the local-check guidance was kept inside the existing Milestone 2 documentation flow so the repository structure remained unchanged.

This checkpoint guidance now emphasizes:

  • confirming that the basic local tools still work

  • confirming that terminal handling is no longer a blocker

  • confirming that the node or RPC path is still reachable

  • confirming that the developer knows which endpoint actually worked

  • confirming that official documentation should still be used whenever the repository marks a detail for later verification

  • confirming that a beginner can classify common early failure types before assuming the node is broken

This keeps the Milestone 2 readiness checks practical without creating an unplanned structural change in the docs directory.

5. README Scope Messaging Updated For Milestone 2

The top-level README was updated so the repository no longer reads as if only Milestone 1 exists.

The updated wording now makes it clear that:

  • Milestone 1 remains the completed documentation foundation

  • Milestone 2 has started

  • the first Milestone 2 additions are CKB-specific setup, RPC basics, and local verification guidance

  • later sections are still placeholders unless validated

This improves project-state clarity without claiming that Milestone 2 is complete.

6. Commands For Week 1 Milestone 2 Were Kept Explicit

The Week 1 Milestone 2 documentation includes the following exact commands where repository validation already existed:

  • npm install -g @offckb/cli

  • offckb --help

  • offckb node

  • offckb clean

  • Example local RPC validation command (tested against local CKB node)

The documentation did not add new exact commands in areas that are still marked for later verification.

Remaining Scope For Week 2 Of Milestone 2

The second week of Milestone 2 should focus on completing the remaining planned CKB-specific content modules that are still placeholders.

The next sections to complete are:

  • docs/06-indexer-setup.md

  • docs/08-first-developer-workflow.md

  • docs/09-common-errors-and-remediation.md

  • docs/10-troubleshooting-matrix.md

  • docs/11-ai-assisted-debugging.md

  • docs/12-ckb-mental-model.md

  • docs/13-common-misconceptions.md

  • docs/13-common-misconceptions.md

3 Likes
CKB Ecosystem Biweekly Update