|
| 1 | ++++ |
| 2 | +title = "Documentation Guide" |
| 3 | +description = "How to work with Bull Mobile documentation using Zola" |
| 4 | +date = 2025-07-04 |
| 5 | +authors = ["ethicnology"] |
| 6 | + |
| 7 | +[taxonomies] |
| 8 | +categories = ["dev"] |
| 9 | +tags = ["documentation", "zola"] |
| 10 | + |
| 11 | +[extra] |
| 12 | +toc = true |
| 13 | ++++ |
| 14 | + |
| 15 | +This guide explains how to work with Bull Mobile's documentation system built with [Zola](https://www.getzola.org/). |
| 16 | + |
| 17 | +## What is Zola? |
| 18 | + |
| 19 | +Zola is a fast static site generator written in Rust. It's used to build our documentation site from Markdown files. |
| 20 | + |
| 21 | +## Project Structure |
| 22 | + |
| 23 | +``` |
| 24 | +docs/zola/ |
| 25 | +├── config.toml # Site configuration |
| 26 | +├── content/ # Markdown content files |
| 27 | +│ ├── _index.md # Homepage |
| 28 | +│ ├── getting-started.md |
| 29 | +│ ├── security.md |
| 30 | +│ └── ... |
| 31 | +├── static/ # Static assets (images, videos, etc.) |
| 32 | +│ ├── bull/ |
| 33 | +│ └── coldcard-q/ |
| 34 | +├── themes/ # Zola theme (radion) |
| 35 | +└── templates/ # Custom templates (if needed) |
| 36 | +``` |
| 37 | + |
| 38 | +## Adding New Content |
| 39 | + |
| 40 | +### Creating a New Page |
| 41 | + |
| 42 | +1. Create a new `.md` file in the `content/` directory |
| 43 | +2. Add frontmatter at the top: |
| 44 | + |
| 45 | +```markdown |
| 46 | ++++ |
| 47 | +title = "Watch-Only Wallets" |
| 48 | +description = "Descriptors, xpub, ypub, zpub…" |
| 49 | +date = 2025-07-04 |
| 50 | +authors = ["ethicnology", "ishi"] |
| 51 | + |
| 52 | +[taxonomies] |
| 53 | +categories = ["guides"] |
| 54 | +tags = ["watch only", "ColdCard Q", "wallet"] |
| 55 | + |
| 56 | +[extra] |
| 57 | +toc = true |
| 58 | ++++ |
| 59 | + |
| 60 | +Your content here... |
| 61 | +``` |
| 62 | + |
| 63 | +### Frontmatter Options |
| 64 | + |
| 65 | +- **title**: Page title (required) |
| 66 | +- **description**: Page description for SEO |
| 67 | +- **date**: Publication date |
| 68 | +- **taxonomies**: Categories and tags for organization |
| 69 | +- **extra.toc**: Enable table of contents |
| 70 | + |
| 71 | +### Available Categories |
| 72 | + |
| 73 | +- `guides` - How-to guides and tutorials |
| 74 | +- `security` - Security-related content |
| 75 | +- `technical` - Technical documentation |
| 76 | +- `dev` - Developer documentation |
| 77 | +- `support` - Support and troubleshooting |
| 78 | + |
| 79 | +## Code Blocks |
| 80 | + |
| 81 | +### Syntax Highlighting |
| 82 | + |
| 83 | +```dart |
| 84 | +// Dart code example |
| 85 | +class WalletService { |
| 86 | + Future<void> initializeWallet() async { |
| 87 | + // Your code here |
| 88 | + } |
| 89 | +} |
| 90 | +``` |
| 91 | + |
| 92 | +### Configuration Examples |
| 93 | + |
| 94 | +```toml |
| 95 | +[network] |
| 96 | +network_type = "mainnet" |
| 97 | +``` |
| 98 | + |
| 99 | +```json |
| 100 | +{ |
| 101 | + "servers": [ |
| 102 | + "electrum.example.com:50002" |
| 103 | + ] |
| 104 | +} |
| 105 | +``` |
| 106 | + |
| 107 | +## Building and Serving |
| 108 | + |
| 109 | +### Development Server |
| 110 | + |
| 111 | +```bash |
| 112 | +cd docs/zola |
| 113 | +zola serve |
| 114 | +``` |
| 115 | + |
| 116 | +This starts a local server at `http://127.0.0.1:1111` |
| 117 | + |
| 118 | +### Build for Production |
| 119 | + |
| 120 | +```bash |
| 121 | +cd docs/zola |
| 122 | +zola build |
| 123 | +``` |
| 124 | + |
| 125 | +This creates a `public/` directory with the built site. |
| 126 | + |
| 127 | +## Theme Features |
| 128 | + |
| 129 | +The radion theme provides: |
| 130 | + |
| 131 | +- **Dark/Light Mode**: Toggle in the top navigation |
| 132 | +- **Search**: Full-text search across all content |
| 133 | +- **Categories & Tags**: Browse content by topic |
| 134 | +- **Table of Contents**: Auto-generated for pages with `toc = true` |
| 135 | +- **Code Highlighting**: Syntax highlighting for code blocks |
| 136 | +- **Responsive Design**: Works on mobile and desktop |
| 137 | + |
| 138 | +### Getting Help |
| 139 | + |
| 140 | +- [Zola Documentation](https://www.getzola.org/documentation/getting-started/overview/) |
| 141 | +- [Radion Theme Documentation](https://github.com/micahkepe/radion) |
| 142 | +- Check existing content for examples |
0 commit comments