Skip to content

Commit 615b7e5

Browse files
authored
Fix import issues (#30)
This PR closes issues #2 and #24. I've manually transformed and compared the docs from https://github.com/jetify-com/devbox/commit/e8dfb82a^ before they were removed.
1 parent 4cdfc02 commit 615b7e5

56 files changed

Lines changed: 387 additions & 172 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.

docs/cloud/deploys/setup/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Below is an example `devbox.json` that can be used for a simple Go project in Je
3333

3434
```json
3535
{
36-
"packages": ["[email protected]"],
36+
"packages": ["go@1.19.8"],
3737
"env": {
3838
"GOPATH": "$HOME/go/",
3939
"PATH": "$PATH:$HOME/go/bin"

docs/devbox/cli-reference/devbox-cache-configure/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ If the current Nix installation is multi-user, this command grants the Nix daemo
77
caches by making the following changes:
88

99
- Adds the current user to Nix's list of trusted users in the system nix.conf.
10-
- Adds the cache credentials to \~root/.aws/config.
10+
- Adds the cache credentials to \~/.aws/config.
1111

1212
Configuration requires sudo, but only needs to happen once. The changes persist across Devbox
1313
accounts and organizations.

docs/devbox/cli-reference/devbox-completion-bash/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ install it via your OS's package manager.
99
To load completions in your current shell session:
1010

1111
```bash
12-
source <(devbox completion bash)
12+
source <(devbox completion bash)
1313
```
1414

1515
To load completions for every new session, execute once:
1616

1717
## Linux[](#linux "Direct link to Linux")
1818

1919
```bash
20-
devbox completion bash > /etc/bash_completion.d/devbox
20+
devbox completion bash > /etc/bash_completion.d/devbox
2121
```
2222

2323
## macOS[](#macos "Direct link to macOS")

docs/devbox/cli-reference/devbox-completion-zsh/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ devbox completion zsh > ~/.oh-my-zsh/completions/_devbox
1313
If you are not using Oh My Zsh and shell completion is not already enabled in your environment you
1414
will need to enable it. You can execute the following once:
1515

16-
```
16+
```bash
1717
echo "autoload -U compinit; compinit" >> ~/.zshrc
1818
```
1919

docs/devbox/cli-reference/devbox-generate-direnv/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: "devbox generate direnv"
33
description:
44
"Top level command for generating the .envrc file for your Devbox Project. This can be used
5-
with to automatically start your shell when you cd into your devbox directory"
5+
with [direnv](/docs/devbox/ide-configuration/direnv/) to automatically start your shell when
6+
you cd into your devbox directory"
67
---
78

89
```bash

docs/devbox/cli-reference/devbox-global-services/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "devbox global services"
33
description:
44
"Interact with Devbox services for your global packages. This command replicates the subcommands
5-
for but for your global packages."
5+
for [devbox services](/docs/devbox/cli-reference/devbox-services/) but for your global packages."
66
---
77

88
```bash

docs/devbox/cli-reference/devbox-global-update/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ description: "Updates packages in your Devbox global config to the latest availa
88
If you provide this command with a list of packages, it will update those packages to the latest
99
available version based on the version tag provided.
1010

11-
For example: if your global config has `[email protected]` in your package list, running
12-
`devbox update` will update to the latest patch version of `python 3.11`.
11+
For example: if your global config has `python@3.11` in your package list, running `devbox update`
12+
will update to the latest patch version of `python 3.11`.
1313

1414
If no packages are provided, this command will update all the versioned packages to the latest
1515
acceptable version.

docs/devbox/cli-reference/devbox-run/index.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: "devbox run"
33
description:
44
"Starts a new interactive shell and runs your target script in it. The shell will exit once your
5-
target script is completed or when it is terminated via CTRL-C. Scripts can be defined in your ."
5+
target script is completed or when it is terminated via CTRL-C. Scripts can be defined in your
6+
`devbox.json`."
67
---
78

89
You can also run arbitrary commands in your devbox shell by passing them as arguments to

docs/devbox/cli-reference/devbox-search/index.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@ devbox search <pkg> [flags]
1717

1818
## Example[](#example "Direct link to Example")
1919

20-
```bash
20+
```
2121
$ devbox search ripgrep
2222
Warning: Search is experimental and may not work as expected.
2323
Found 8+ results for "ripgrep":
2424
* ripgrep (13.0.0, 12.1.1, 12.0.1)
2525
* ripgrep-all (0.9.6, 0.9.5)
2626
2727
# To add ripgrep 12.1.1 to your project:
28-
$ devbox add [email protected]
28+
29+
$ devbox add ripgrep@12.1.1
2930
```
3031

3132
## Options[](#options "Direct link to Options")

docs/devbox/cli-reference/devbox-services-attach/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: "devbox services attach"
33
description:
4-
"Attach to a running instance of . This command lets you launch the TUI for process-compose if you
5-
started your services in the background with ."
4+
"Attach to a running instance of `devbox services`. This command lets you launch the TUI for
5+
process-compose if you started your services in the background with `devbox services up -b`."
66
---
77

88
Note that terminating the TUI will not stop your backgrounded services. To stop your services, use

0 commit comments

Comments
 (0)