Skip to content

docs: Add Docker cleanup commands to readme #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erinxocon merged 1 commit into from
Jun 11, 2026
Merged

docs: Add Docker cleanup commands to readme #376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,13 @@ The book can be viewed and edited on GitHub by going to
- Clone the repository using `git`.
- From the cloned repository run
- `devcontainer up`
- `devcontainer pnpm install`
- `devcontainer pnpm dev`
- `devcontainer exec pnpm install`
- `devcontainer exec pnpm dev`
- You may now view the book at `http://localhost:4321/tech-docs`
- Edits are made in the `src/content/docs` directory. The server will automatically update

#### Cleanup

- When finished editing, run `docker ps` to get the container's ID or name
- To stop the container (for quicker setup next time), run `docker stop <container>`
- To stop and remove the container (to start fresh next time), `docker rm -f <container>`