Skip to content

Commit efd4997

Browse files
docs(devcontainer): Basic guidance
1 parent 4871f38 commit efd4997

File tree

5 files changed

+16
-9
lines changed

5 files changed

+16
-9
lines changed

package.json-scripts.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,26 @@
77
"scriptName": "devcontainer:build",
88
"scriptCode": "docker build --tag kitten-game .",
99
"isGlobal": true,
10-
"isRootManifest": false
10+
"isRootManifest": false,
11+
"description": "Builds the Development Container."
1112
},
1213
{
1314
"manifestPath": "packages/kitten-game/package.json",
1415
"projectName": "@kitten-science/kitten-game",
1516
"scriptName": "devcontainer:rebuild",
1617
"scriptCode": "docker build --no-cache --tag kitten-game .",
1718
"isGlobal": true,
18-
"isRootManifest": false
19+
"isRootManifest": false,
20+
"description": "Rebuilds the development container.\n\nYou're going to want to rebuild your development container every once in a while to ensure you're using the latest version of Kittens Game in your container."
1921
},
2022
{
2123
"manifestPath": "packages/kitten-game/package.json",
2224
"projectName": "@kitten-science/kitten-game",
2325
"scriptName": "devcontainer:run",
2426
"scriptCode": "bash ./scripts/run-development-container.sh",
2527
"isGlobal": true,
26-
"isRootManifest": false
28+
"isRootManifest": false,
29+
"description": "Builds the development container and starts it."
2730
},
2831
{
2932
"manifestPath": "packages/documentation/package.json",

packages/documentation/docs/reference/Repository Scripts/.devcontainer$$build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99

1010
- Description:
1111

12-
_documentation pending_
12+
Builds the Development Container.

packages/documentation/docs/reference/Repository Scripts/.devcontainer$$rebuild.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,6 @@
99

1010
- Description:
1111

12-
_documentation pending_
12+
Rebuilds the development container.
13+
14+
You're going to want to rebuild your development container every once in a while to ensure you're using the latest version of Kittens Game in your container.

packages/documentation/docs/reference/Repository Scripts/.devcontainer$$run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99

1010
- Description:
1111

12-
_documentation pending_
12+
Builds the development container and starts it.

packages/documentation/docs/reference/Repository Scripts/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
- Description:
1313

14-
_documentation pending_
14+
Builds the Development Container.
1515

1616
## devcontainer:rebuild
1717

@@ -24,7 +24,9 @@
2424

2525
- Description:
2626

27-
_documentation pending_
27+
Rebuilds the development container.
28+
29+
You're going to want to rebuild your development container every once in a while to ensure you're using the latest version of Kittens Game in your container.
2830

2931
## devcontainer:run
3032

@@ -37,7 +39,7 @@
3739

3840
- Description:
3941

40-
_documentation pending_
42+
Builds the development container and starts it.
4143

4244
## docs:build
4345

0 commit comments

Comments
 (0)