Skip to content

Commit c65f057

Browse files
authored
Merge pull request #981 from SatoshiPortal/develop
5.3.1
2 parents f3f3312 + b2576ae commit c65f057

274 files changed

Lines changed: 15091 additions & 3760 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: checkout
14+
uses: actions/checkout@v4
15+
- name: build_and_deploy
16+
uses: shalzz/zola-deploy-action@master
17+
env:
18+
PAGES_BRANCH: gh-pages
19+
TOKEN: ${{ secrets.TOKEN_GH_PAGES }}

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# See https://www.dartlang.org/guides/libraries/private-files
22

3+
# Zola
4+
docs/zola/public/
5+
6+
# # Untrack unused platform files
7+
macos/
8+
linux/
9+
windows/
10+
311
# Files and directories created by pub
412
.dart_tool/
513
.packages

analysis_options.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ linter:
66
avoid_dynamic_calls: false
77
no_wildcard_variable_uses: false
88
unawaited_futures: true
9+
avoid_redundant_argument_values: false
910

1011

1112
analyzer:
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/zola/config.toml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# The URL the site will be built for
2+
base_url = "https://example.com"
3+
4+
# The site title
5+
title = "BULL Documentation"
6+
7+
theme = "radion"
8+
9+
# Whether to automatically compile all Sass files in the sass directory
10+
compile_sass = false
11+
12+
# Whether to build a search index to be used later on by a JavaScript library
13+
build_search_index = true
14+
15+
# Taxonomies configuration for the theme
16+
taxonomies = [
17+
{name = "categories", feed = true},
18+
{name = "tags", feed = true},
19+
]
20+
21+
[markdown]
22+
# Whether to do syntax highlighting
23+
# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
24+
highlight_code = true
25+
26+
[extra]
27+
radion_menu = [
28+
{url = "$BASE_URL", name = "Home"},
29+
{url = "$BASE_URL/categories", name = "Categories"},
30+
{url = "$BASE_URL/tags", name = "Tags"},
31+
]
32+
codeblock = true
33+
github = "https://github.com/SatoshiPortal/bullbitcoin-mobile"
34+
paginate_by = 5
35+
# Disable comments to avoid giscus errors
36+
comments = false
37+
38+
enable_search = true
39+
theme = "toggle" # Light and Dark Modes
40+
41+
42+
[search]
43+
index_format = "elasticlunr_json"
44+
45+
46+
47+
48+
49+

docs/zola/content/_index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
+++
2+
title = "BULL Documentation"
3+
description = "Documentation for Bull Bitcoin mobile app"
4+
paginate_by = 5
5+
+++
6+
7+
Welcome to the Bull Bitcoin mobile app documentation.

docs/zola/content/documentation.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
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

Comments
 (0)