V3 Plan

[RetricSu]

See #347 (comment) and #347 (comment)

We plan to ship a V3 version of the doc site before the end of June.

What features/content should be included in the V3 version?

Some ideas:

• Comparison information: Bitcoin and CKB differences
• (optional) Overview page(guideline of the doc site, like https://ethereum.org/en/developers/docs/) bad idea?
• All in one page: Link to all resources ( https://academy.ckb.dev/ https://cookbook.ckbdapps.com/ etc)
• Better UX/UI
  • Tooltips for terms on each page
• Common Scripts
  • How this Script works
  • Script deployed info
  • Offchain SDK examples
  • On-chain integration examples
• Wallets
  • CCC integration tutorials
  • offckb template integrated with wallets
  • New supported wallets update
• Enhance Visual Accessibility for tech explanation Enhance Visual Accessibility in Concepts Section #240
  • Enhance How CKB works with intuitive concept images (Cell box vs UTXO box)
  • Concept in Tech explanation with flowchart
• SDK Section
• How-to Section
• Molecule Section
• RFC listed
  • Chat with LLM for RFC?

[RetricSu]

Principle:

• https://docs.divio.com/documentation-system/

Some docs site examples worth learning:

• https://learnmeabitcoin.com/
• https://ethereum.org/en/developers/docs/

[yfeng2824]

(optional) Overview page(guideline of the doc site, like https://ethereum.org/en/developers/docs/) bad idea?

I don't think we need an overview page since our current landing page already serves that purpose. Instead, we can analyze user behavior and adjust our starting points to better meet their needs.

---

Besides the ideas shared above, I thought we could add tooltips for terms on each page. This would give users instant explanations without needing to navigate away, making the content more accessible and saving time. We can use the first sentence from our glossary.md for the tooltip content and include a "learn more" link for deeper exploration on the glossary or the relevant page.
It might look something like this:

[RetricSu]

yeah i like this idea too, ckb academy have something like this https://academy.ckb.dev/courses/basic-theory

[linnnsss]

A few questions about the arrangement of the tentative categories:

1. For serialization, maybe better to place it under 'how-to' or 'tech explanation'? But if it is a core and frequently encountered component, keeping it as a top-level category is fine.

2. Similarly, for 'common scripts', placing it under 'Scripts (Smart Contracts)' might be preferable. If this makes the structure too deep, keeping it directly under Scripts would be fine.

3. For the 'How-tos', we've already gathered a list of topics, or do we need to collect them from the developers?

[RetricSu]

1. yea it is a core component
2. I feel like it will be too deep
3. we have very few topics, need to collect

[RetricSu]

Doc V3 Plan

• New content

  • Comparison: Bitcoin and CKB differences @RetricSu @yfeng2824

    • Stack vs CKB-VM
    • UTXO vs Cell
    • Transaction Structure
    • POW

  • Dapp Section @RetricSu

    • full-stack simple lock example
    • (optional) full-stack dex example

  • Script Section

    • migrate xuejie's blog posts @RetricSu
    • CKB syscall for Script (based on RFC ) @linnnsss
    • Script Cycles Limits (based on RFC)
    • (optioanl) Compiling Script (based on Script toolchain maintaince report)

  • Common Scripts(Omnilock/Xudt) @RetricSu @linnnsss

    • How this Script works @RetricSu
    • Script deployed info @RetricSu
    • Offchain SDK examples @linnnsss
    • (optional) On-chain integration examples

  • SDK Section(Rust/Java/Javascript/Typescript/Other Devtools) @yfeng2824

    • Introduce(suitable for what kind of situation)
    • Requirements
    • Examples

  • Integrate Wallets @RetricSu

    • CCC integration tutorials
    • offckb template integrated with wallets
    • New supported wallets update if any

  • Molecule Section

    • Why do I need this?
    • How Molecule Works @linnnsss based on https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0008-serialization/0008-serialization.md
    • (optional) Offchain Examples
    • (optioanl) OnChain Examples

  • Ecosystem Section

    • github orgs @yfeng2824

  • Resource Links @linnnsss

    • https://academy.ckb.dev/
    • https://cookbook.ckbdapps.com/
    • RGB++
    • Spore
    • Other useful links

  • How-to Section

    • https://github.com/nervosnetwork/ckb-system-scripts/wiki/How-to-sign-transaction @linnnsss
    • (optional) how to calculate all kinds of hashes
      • specs
      • SDKs & tools

  • Tech-Explanation Section @linnnsss

    • ckb-address
    • Others..

• Better UX/UI

  • Tooltips for terms on each page @yfeng2824
  • Readability improvement on UI @yfeng2824
  • Enhance Visual Accessibility
    • For concepts in Tech explanation with flowchart Enhance Visual Accessibility in Concepts Section #240
      • Cell
      • Script
      • WitnessArgs
    • For How CKB works with intuitive concept images (Cell box vs UTXO box)
  • Redirect dead links(maybe use https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects) @RetricSu
    • /docs/basics/guides/mining-ckb （直接跳转）
    • /docs/reference/halving (从旧文档整理出新的）
    • /docs/basics/guides/crypto wallets/neuron （integrate wallet)

• Research(optional) @RetricSu

  • Chat with LLM based on RFC docs

[RetricSu]

V3 Menu Structure

• Getting Started

  • How CKB Works
  • Quick Start(5m)
  • Blockchain Networks
  • CKB vs BTC difference
  • UTXO vs Account Model

• SDK & Devtools

  • Rust
  • Go
  • Java
  • Javascript/Typescript (Lumos)
  • CommandLine Tool (CLI)
  • Other Dev Tools

• DApp Tutorials

  • Transfer CKB
  • Store Data on Cell
  • Create a Fungible Token
  • Create a DOB
  • Build a Simple Lock
  • Build a Simple Dex

• Scripts(Smart Contract)

  • How Script Works
  • Language Choices for Script
  • CKB syscall for Script
  • Script Cycles Limits
  • Tutorial: Minimal Script
  • Tutorial: User Defined Token(UDT)
  • Tutorial: Type ID (Upgradable Script)
  • Tutorial: Run Javascript on CKB
  • Tutorial: Script With Dynamic Linking
  • Tutorial: Call Script from Script with Spawn
  • Compile Script
  • Debug and Testing Script
  • Deploy Script to CKB
  • Script Error Code

• Integrate Wallets

  • Select Your Wallets
    • Unisat/Metamask
  • All-In-One With CCC connector
  • ...

• Common Scripts

  • Omnilock
    • How this Script works
    • Script deployed info
    • Offchain SDK examples
    • On-chain integration examples
  • Xudt
  • DAO

• Network & Nodes

  • RPCs
  • Run a Mainnet Node
  • Run a Testnet Node
  • Run a Devnet Node
  • Run a Public RPC Node

• Molecule(Serialization)

  • Why do I need this?
  • How Molecule Works
  • Example
  • ...

• How-to Guide

  • How to Sign transactions
  • How to use Since
  • How to calculate transaction hash
  • ...

• Tech Explanation

  • ....
  • Hash Type
  • Dep Group
  • Dep Cell
  • Cell Dep
  • Type Script
  • Lock Script
  • Script Args
  • ...
  • Concept Glossary

• Mining CKB

• Ecosystem

  • Projects
  • Code Repos
  • Communities(TBD)

• Contribution

  • How to Contribute
  • List of Tasks
  • Code of Conduct

• Resources

  • Position Paper
  • CKB RFCs
  • CKB Dev Log
  • Other Docs
  • Other Resources
  • ...