This directory contains the source for the BitCell documentation website, built with mdBook.

cargo install mdbook --version 0.4.37

cd docs/book
mdbook build

Output will be in docs/book/book/.

cd docs/book
mdbook serve --open

This will start a local server at http://localhost:3000 with live reload.

docs/book/
├── book.toml          # mdBook configuration
├── src/
│   ├── SUMMARY.md     # Table of contents
│   ├── introduction.md
│   ├── getting-started/
│   ├── node/
│   ├── wallet/
│   ├── contracts/
│   ├── api/
│   ├── concepts/
│   ├── advanced/
│   ├── development/
│   └── appendix/
└── book/              # Built output (gitignored)

To contribute to documentation:

1. Edit markdown files in src/
2. Test locally with mdbook serve
3. Submit a pull request

• Use clear, concise language
• Include code examples where appropriate
• Add links to related sections
• Test all commands/code samples
• Use consistent formatting

Documentation is automatically built and deployed to GitHub Pages via .github/workflows/deploy-docs.yml when changes are pushed to master.

View live documentation at: https://docs.bitcell.network