Skip to content

Commit 0680a5f

Browse files
authored
Merge pull request #309 from iMattPro/fixes
Improve docs
2 parents a297890 + ea4eef8 commit 0680a5f

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ QuickInstall now includes a Docker-based CLI for creating local phpBB test board
6464
```bash
6565
php bin/qi init
6666
php bin/qi board:create test --phpbb 3.3 --db mariadb --port 8081 --populate extension-dev
67-
php bin/qi board:start test
6867
```
6968

7069
The QuickInstall CLI targets phpBB 3.2+ installer-based boards. phpBB 3.0/3.1 remain legacy-web-app territory and are not planned for the QuickInstall CLI.

docs/sandbox-cli.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,10 @@ Create your first board:
2424

2525
```bash
2626
php bin/qi board:create demo --phpbb 3.3 --db mariadb --port 8081 --populate none
27-
php bin/qi board:start demo
2827
```
2928

29+
When creation finishes, QuickInstall asks whether to start the board.
30+
3031
Open:
3132

3233
```text
@@ -39,7 +40,7 @@ Admin login:
3940
admin / password
4041
```
4142

42-
That is the normal workflow. `board:create` downloads the requested phpBB source if needed, writes Docker config, and prepares the board. `board:start` starts the board containers with Docker Compose, installs phpBB, applies the selected seed preset once, and waits until the board URL responds before printing the final URL.
43+
That is the normal workflow. `board:create` downloads the requested phpBB source if needed, writes Docker config, prepares the board, and offers to start it. Starting a board starts the containers with Docker Compose, installs phpBB, applies the selected seed preset once, and waits until the board URL responds before printing the final URL.
4344

4445
If you ever need help with commands, run:
4546

@@ -53,35 +54,30 @@ Create a small empty board:
5354

5455
```bash
5556
php bin/qi board:create clean --phpbb 3.3 --db mariadb --port 8081 --populate none
56-
php bin/qi board:start clean
5757
```
5858

5959
Create a board with extension-development fixtures:
6060

6161
```bash
6262
php bin/qi board:create extdev --phpbb 3.3.17 --db mariadb --port 8082 --populate extension-dev
63-
php bin/qi board:start extdev
6463
```
6564

6665
Create a board with phpBB debug output enabled:
6766

6867
```bash
6968
php bin/qi board:create debug --phpbb 3.3 --db mariadb --port 8085 --populate extension-dev --debug
70-
php bin/qi board:start debug
7169
```
7270

7371
Create an older supported phpBB 3.2 board:
7472

7573
```bash
7674
php bin/qi board:create old --phpbb 3.2 --db mariadb --port 8083 --populate tiny
77-
php bin/qi board:start old
7875
```
7976

8077
Create an experimental master branch board:
8178

8279
```bash
8380
php bin/qi board:create alpha --phpbb master --db mariadb --port 8084 --populate tiny
84-
php bin/qi board:start alpha
8581
```
8682

8783
List boards (shows all created boards and their statuses):
@@ -90,6 +86,12 @@ List boards (shows all created boards and their statuses):
9086
php bin/qi board:list
9187
```
9288

89+
Start a board:
90+
91+
```bash
92+
php bin/qi board:start demo
93+
```
94+
9395
Stop or remove a board:
9496

9597
```bash
@@ -375,10 +377,9 @@ docker compose -f .qi/runtime/demo/compose.yml logs db
375377

376378
#### Reset a board completely
377379

378-
Use this when a board's files, database, or generated Docker runtime are no longer worth repairing. Destroying a board removes its generated state, so create and start it again afterward.
380+
Use this when a board's files, database, or generated Docker runtime are no longer worth repairing. Destroying a board removes its generated state, so create it again afterward.
379381

380382
```bash
381383
php bin/qi board:destroy demo
382384
php bin/qi board:create demo --phpbb 3.3 --db mariadb --port 8081 --populate none
383-
php bin/qi board:start demo
384385
```

0 commit comments

Comments
 (0)