Skip to main content

Consensus Light Client — Documentation Progress

Status: COMPLETE​

Stage 1: Define Use Cases ✅​

  • 2 guides covering 3 use cases
  • Guide 1: Verified State Queries (primary — simple path with UseVerifiedState)
  • Guide 2: Beacon Chain Light Client (protocol internals)
  • 2 plugin skills: verified-state, light-client

Stage 2: Validate READMEs ✅​

Validated 6 packages:

  • Nethereum.Beaconchain — NO README (created in Stage 3)
  • Nethereum.Ssz — minor gap (VerifyProof missing)
  • Nethereum.Consensus.Ssz — property name errors, missing types
  • Nethereum.Consensus.LightClient — async anti-pattern in Example 9
  • Nethereum.ChainStateVerification — missing Interceptor subsystem docs
  • Nethereum.Signer.Bls.Herumi — missing methods

Stage 3: Fix READMEs ✅​

All fixes applied:

  1. Created Nethereum.Beaconchain/README.md
  2. Added Interceptor/UseVerifiedState to ChainStateVerification README
  3. Fixed PubKeys/AggregatePubKey property names in Consensus.Ssz README
  4. Added LightClientUpdate/FinalityUpdate/OptimisticUpdate/SyncAggregate to Consensus.Ssz README
  5. Fixed CombineFixedAndDynamicSections → Combine in Consensus.Ssz README
  6. Fixed SszContainerEncoding visibility in Consensus.Ssz README
  7. Fixed Decode parameter types in Consensus.Ssz README
  8. Fixed Example 9 async anti-pattern in Consensus.LightClient README
  9. Added SszMerkleizer.VerifyProof to Ssz README
  10. Added missing BLS methods + fixed class name in Signer.Bls.Herumi README
  • Updated sync-readmes.js mapping: Beaconchain → consensus-light-client
  • Ran sync script, build passes

Stage 4: Create Guide Pages ✅​

  • docs/consensus-light-client/guide-verified-state.md (448 lines)
  • docs/consensus-light-client/guide-light-client.md (338 lines)
  • Updated sidebars.ts with Guides category (collapsed: false)
  • Updated overview.md with guide tables and simple path

Stage 4b: Validate Learning Journey ✅​

  • Guide 1 → Guide 2 Next Steps chain verified
  • Both guides have teaching prose, no code dumps
  • Simple path (UseVerifiedState) leads guide 1
  • Opening context connects to the section's purpose

Stage 5: Create Plugin Skills ✅​

  • plugins/nethereum-skills/skills/verified-state/SKILL.md
  • plugins/nethereum-skills/skills/light-client/SKILL.md

Stage 5b: Update Global Pages ✅​

  • what-do-you-want-to-do.md — 3 rows added
  • component-catalog.md — Quick Start rows + package category added
  • src/pages/index.tsx — section description updated + Verification task group added
  • Fixed broken links (packages in shared directories)

Stage 6: Final Verification ✅​

  • npm run build passes (only pre-existing MUD anchor warning)
  • All section links resolve correctly
  • Sidebar structure follows standard (Overview → Guides → Package Reference)