Skip to content

docs: reorder readme steps for devcontainer #178

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
sunib merged 1 commit into from
Jul 3, 2026
Merged

docs: reorder readme steps for devcontainer #178

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
17 changes: 9 additions & 8 deletions .devcontainer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,7 @@ interactive debugging inside the devcontainer.

## Quick Start

### VS Code

1. Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
2. Open the project in VS Code: `code .`
3. Press `F1` and run `Dev Containers: Reopen in Container`
4. Wait for the initial build to finish

### Before Reopening In Container
### Prerequisites (Before Reopening In Container)

This repo expects SSH agent forwarding for commit signing.

Expand All @@ -31,6 +24,14 @@ git config --global user.email "you@example.com"

If `ssh-add -L` shows no keys, commit signing inside the devcontainer will fail.


### VS Code

1. Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
2. Open the project in VS Code: `code .`
3. Press `F1` and run `Dev Containers: Reopen in Container`
4. Wait for the initial build to finish

### Verify

```bash
Expand Down