From 5c4b8dd8c1be8e4635ef46b0a524c3fa385834ed Mon Sep 17 00:00:00 2001 From: Snider Date: Thu, 29 Jan 2026 15:30:50 +0000 Subject: [PATCH] docs: fix broken subcommand links in pkg and dev indexes Commands documented inline don't need directory links. Only link to directories that actually exist. Co-Authored-By: Claude Opus 4.5 --- docs/cmd/dev/index.md | 34 +++++++++++----------- docs/cmd/pkg/index.md | 65 ++++++++++++++++++++++++++++++++++++++----- 2 files changed, 75 insertions(+), 24 deletions(-) diff --git a/docs/cmd/dev/index.md b/docs/cmd/dev/index.md index e65713cb..4f063b47 100644 --- a/docs/cmd/dev/index.md +++ b/docs/cmd/dev/index.md @@ -7,28 +7,28 @@ Multi-repo development workflow and portable dev environment. | Command | Description | |---------|-------------| | [work](work/) | Full workflow: status + commit + push | -| [health](health/) | Quick health check across repos | -| [commit](commit/) | Claude-assisted commits | -| [push](push/) | Push repos with unpushed commits | -| [pull](pull/) | Pull repos that are behind | -| [issues](issues/) | List open issues | -| [reviews](reviews/) | List PRs needing review | -| [ci](ci/) | Check CI status | -| [impact](impact/) | Show dependency impact | +| `health` | Quick health check across repos | +| `commit` | Claude-assisted commits | +| `push` | Push repos with unpushed commits | +| `pull` | Pull repos that are behind | +| `issues` | List open issues | +| `reviews` | List PRs needing review | +| `ci` | Check CI status | +| `impact` | Show dependency impact | ## Dev Environment Commands | Command | Description | |---------|-------------| -| [install](install/) | Download the core-devops image | -| [boot](boot/) | Start the environment | -| [stop](stop/) | Stop the environment | -| [status](status/) | Show status | -| [shell](shell/) | Open shell | -| [serve](serve/) | Start dev server | -| [test](test/) | Run tests | -| [claude](claude/) | Sandboxed Claude | -| [update](update/) | Update image | +| `install` | Download the core-devops image | +| `boot` | Start the environment | +| `stop` | Stop the environment | +| `status` | Show status | +| `shell` | Open shell | +| `serve` | Start dev server | +| `test` | Run tests | +| `claude` | Sandboxed Claude | +| `update` | Update image | --- diff --git a/docs/cmd/pkg/index.md b/docs/cmd/pkg/index.md index cf97ad21..e801bb4d 100644 --- a/docs/cmd/pkg/index.md +++ b/docs/cmd/pkg/index.md @@ -1,13 +1,64 @@ # core pkg -Package management for core-* repos. +Package management for Go modules. -## Subcommands +## Usage + +```bash +core pkg [flags] +``` + +## Commands | Command | Description | |---------|-------------| -| [search](search/) | Search packages | -| [install](install/) | Install package | -| [list](list/) | List installed | -| [update](update/) | Update packages | -| [outdated](outdated/) | Check outdated | +| [search](search/) | Search packages on GitHub | +| `install` | Install a package | +| `list` | List installed packages | +| `update` | Update packages | +| `outdated` | Check for outdated packages | + +## pkg install + +Install a Go module. + +```bash +core pkg install [flags] +``` + +### Examples + +```bash +core pkg install github.com/host-uk/core-php +core pkg install github.com/spf13/cobra@latest +``` + +## pkg list + +List installed packages. + +```bash +core pkg list +``` + +## pkg update + +Update packages to latest versions. + +```bash +core pkg update [flags] +``` + +### Flags + +| Flag | Description | +|------|-------------| +| `--all` | Update all packages | + +## pkg outdated + +Check for outdated packages. + +```bash +core pkg outdated +```