Skip to content

Add mdbook user documentation#11

Merged
andy-thomason merged 2 commits intomainfrom
feat/user-docs
Mar 20, 2026
Merged

Add mdbook user documentation#11
andy-thomason merged 2 commits intomainfrom
feat/user-docs

Conversation

@luishsr
Copy link
Collaborator

@luishsr luishsr commented Mar 19, 2026

Summary

  • Add book-style (mdbook) user documentation covering the full RBFT workflow
  • 17 chapters organized into: Getting Started, Running a Chain, Deploying Contracts, Interacting with the Chain, Operations, and Architecture
  • Add make book target for building the docs
  • Build output goes to target/book/ (already gitignored)

Documentation structure

  • Getting Started — prerequisites, installation
  • Running a Chain — local testnet, follower nodes, validator management, Docker, Kubernetes
  • Deploying Contracts — Cast usage, QBFTValidatorSet reference, deploying custom contracts
  • Interacting — transactions, ERC20 tokens, load testing
  • Operations — full configuration reference, monitoring/logs, troubleshooting
  • Architecture — system overview, QBFT consensus protocol

Closes #3

Add book-style documentation covering chain setup, validator management,
follower nodes, contract deployment, transactions, load testing,
configuration reference, monitoring, troubleshooting, and architecture.

Build with: make book

Closes #3
Copy link
Collaborator

@pedro-lino pedro-lino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the update, left some comments please check them out.

- Fix quorum formula to match code: (2n - 1) / 3 + 1
- Fix proposer election description to match actual rotation logic
- Fix docker push target: docker-tag-registry, not docker-push
- Remove incorrect reference to non-existent QBFTErc20 contract
Copy link
Collaborator

@pedro-lino pedro-lino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks for the adjustments!

@andy-thomason
Copy link
Collaborator

That looks great!

@andy-thomason andy-thomason merged commit 9312413 into main Mar 20, 2026
1 check passed
@andy-thomason andy-thomason deleted the feat/user-docs branch March 20, 2026 12:17
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.

Book-style user level documentation.

4 participants