Skip to content

docs: fix Title Case section headings in DEBUG.md #60

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
kirby88 merged 1 commit into from
Aug 27, 2026
Merged

docs: fix Title Case section headings in DEBUG.md #60

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
12 changes: 6 additions & 6 deletions DEBUG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Both `vixd` and `vix` expose a pprof HTTP server when launched with `--pprof-por

---

## Capture a snapshot
## Capture a Snapshot

Run all commands **while the target process is live**.

### Goroutine dump (blocking / backpressure issues)
### Goroutine Dump (Blocking / Backpressure Issues)

```bash
# vixd
Expand All @@ -24,7 +24,7 @@ curl -s "http://localhost:6060/debug/pprof/goroutine?debug=2" > /tmp/vixd-gorout
curl -s "http://localhost:6061/debug/pprof/goroutine?debug=2" > /tmp/vix-goroutines.txt
```

### Heap snapshot
### Heap Snapshot

```bash
curl -s "http://localhost:6060/debug/pprof/heap" > /tmp/vixd-heap.pprof
Expand All @@ -33,7 +33,7 @@ curl -s "http://localhost:6061/debug/pprof/heap" > /tmp/vix-heap.pprof
go tool pprof -http=:8080 /tmp/vixd-heap.pprof
```

### CPU profile (30-second sample)
### CPU Profile (30-Second Sample)

```bash
curl -s "http://localhost:6060/debug/pprof/profile?seconds=30" > /tmp/vixd-cpu.pprof
Expand All @@ -42,7 +42,7 @@ curl -s "http://localhost:6061/debug/pprof/profile?seconds=30" > /tmp/vix-cpu.pp
go tool pprof -http=:8080 /tmp/vixd-cpu.pprof
```

### All-in-one snapshot script
### All-In-One Snapshot Script

```bash
TS=$(date +%Y%m%d_%H%M%S)
Expand All @@ -60,7 +60,7 @@ done

---

## Debug environment variables
## Debug Environment Variables

Set by `make run-d` / `make run-x` automatically.

Expand Down