Skip to content

Commit 4478bf6

Browse files
authored
Devbox Services 2.0 docs (#886)
## Summary * Move options into a table for better formatting * Update the guide for new process-compose based services * Update CLI docs ## How was it tested? Localhost, Preview at https://devbox-web-john-lago-jetpack-io.cloud.jetpack.dev/devbox/docs/
1 parent bf7c274 commit 4478bf6

39 files changed

+293
-202
lines changed

docs/app/docs/cli_reference/devbox.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ devbox [flags]
88

99
## Options
1010

11-
```text
12-
-h, --help help for devbox
13-
-q, --quiet Quiet mode: Suppresses logs.
14-
```
11+
<!-- Markdown Table of Options -->
12+
| Option | Description |
13+
| --- | --- |
14+
| `-h, --help` | help for devbox |
15+
| `-q, --quiet` | Quiet mode: Suppresses logs. |
1516

1617
## SEE ALSO
1718

docs/app/docs/cli_reference/devbox_add.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@ devbox add <pkg>... [flags]
88

99
## Options
1010

11-
```text
12-
-h, --help help for add
13-
-q, --quiet Quiet mode: Suppresses logs.
14-
```
11+
<!-- Markdown Table of Options -->
12+
| Option | Description |
13+
| --- | --- |
14+
| `-c, --config string` | path to directory containing a devbox.json config file |
15+
| `-h, --help` | help for add |
16+
| `-q, --quiet` | Quiet mode: Suppresses logs. |
17+
1518

1619
## SEE ALSO
1720

docs/app/docs/cli_reference/devbox_cloud.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ devbox cloud [subcommand] [flags]
1212

1313
## Options
1414

15-
```bash
16-
-h, --help help for generate
17-
-q, --quiet Quiet mode: Suppresses logs.
18-
```
15+
<!-- Markdown Table with Options -->
16+
| Option | Description |
17+
| --- | --- |
18+
| `-h, --help` | help for generate |
19+
| `-q, --quiet` | Quiet mode: Suppresses logs. |
1920

2021
## Subcommands
2122

docs/app/docs/cli_reference/devbox_cloud_forward.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,11 @@ $ devbox cloud forward stop
2929

3030
## Options
3131

32-
```text
33-
-h, --help help for forward
34-
-q, --quiet suppresses logs
35-
```
32+
<!-- Markdown Table of Options -->
33+
| Option | Description |
34+
| --- | --- |
35+
| `-h, --help` | help for forward |
36+
| `-q, --quiet` | suppresses logs |
3637

3738
## SEE ALSO
3839

docs/app/docs/cli_reference/devbox_cloud_forward_list.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ devbox cloud forward list [flags]
88

99
## Options
1010

11-
```text
12-
-h, --help help for list
13-
-q, --quiet suppresses logs
14-
```
11+
<!-- Markdown table of options -->
12+
| Option | Description |
13+
| --- | --- |
14+
| `-h, --help` | help for list |
15+
| `-q, --quiet` | suppresses logs |
1516

1617
### SEE ALSO
1718

docs/app/docs/cli_reference/devbox_cloud_forward_stop.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ devbox cloud forward stop [flags]
88

99
## Options
1010

11-
```text
12-
-h, --help help for stop
13-
-q, --quiet suppresses logs
14-
```
11+
<!-- Markdown table of options -->
12+
| Option | Description |
13+
| --- | --- |
14+
| `-h, --help` | help for stop |
15+
| `-q, --quiet` | suppresses logs |
1516

1617
## SEE ALSO
1718

docs/app/docs/cli_reference/devbox_cloud_shell.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ devbox cloud shell
1818
```
1919

2020
## Options
21-
```text
22-
-c, --config string path to directory containing a devbox.json config file
23-
-h, --help help for shell
24-
-u, --username string Github username to use for ssh
25-
-q, --quiet suppresses logs.
26-
```
21+
<!-- Markdown Table of Options -->
22+
| Option | Description |
23+
| --- | --- |
24+
| `-c, --config string` | path to directory containing a devbox.json config file |
25+
| `-h, --help` | help for shell |
26+
| `-u, --username string` | Github username to use for ssh |
27+
| `-q, --quiet` | suppresses logs. |

docs/app/docs/cli_reference/devbox_completion.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ See each sub-command's help for details on how to use the generated script.
1010

1111
## Options
1212

13-
```text
14-
-h, --help help for completion
15-
-q, --quiet suppresses logs-
16-
```
13+
<!-- Markdown Table of Options -->
14+
| Option | Description |
15+
| --- | --- |
16+
| `-h, --help` | help for completion |
17+
| `-q, --quiet` | suppresses logs |
1718

1819
## SEE ALSO
1920

docs/app/docs/cli_reference/devbox_completion_bash.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@ devbox completion bash
3434

3535
## Options
3636

37-
```text
38-
-h, --help help for bash
39-
--no-descriptions disable completion descriptions
40-
-q, --quiet suppresses logs
41-
```
37+
<!-- Markdown Table of Options -->
38+
| Option | Description |
39+
| --- | --- |
40+
| `-h, --help` | help for bash |
41+
| `--no-descriptions` | disable completion descriptions |
42+
| `-q, --quiet` | suppresses logs |
4243

4344
## SEE ALSO
4445

docs/app/docs/cli_reference/devbox_completion_fish.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ devbox completion fish [flags]
2323

2424
## Options
2525

26-
```text
27-
-h, --help help for fish
28-
--no-descriptions disable completion descriptions
29-
-q, --quiet suppresses logs
30-
```
26+
<!-- Markdown Table of Options -->
27+
| Option | Description |
28+
| --- | --- |
29+
| `-h, --help` | help for fish |
30+
| `--no-descriptions` | disable completion descriptions |
31+
| `-q, --quiet` | suppresses logs |
3132

3233
## SEE ALSO
3334

0 commit comments

Comments
 (0)