From 6659017737a0fcd9b8015fd69e56e7e7b428f3d9 Mon Sep 17 00:00:00 2001 From: jdalton Date: Fri, 17 Apr 2026 16:38:19 -0400 Subject: [PATCH] docs: link docs/ from README and fix stale command name MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - README now has a "Further Reading" section that points to the guides in docs/ plus each package's README. Makes it discoverable for anyone onboarding from the top-level README. - Fixes a stale command name in docs/build-guide.md: `pnpm run clean-cache` → `pnpm run clean:cache` (matches the actual package.json script name). - Also corrects `pnpm clean` → `pnpm run clean` in the same block. --- README.md | 8 ++++++++ docs/build-guide.md | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 99d51ad49..d919f1e72 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,14 @@ Key variables for development: | `SOCKET_CLI_API_BASE_URL` | Override API endpoint | | `SOCKET_CLI_NO_API_TOKEN` | Disable default API token | +## Further Reading + +- [`docs/build-guide.md`](docs/build-guide.md) — build pipeline, SEA binaries, cache management +- [`docs/bundle-tools.md`](docs/bundle-tools.md) — how bundled tools (opengrep, trivy, etc.) are integrated +- [`packages/cli/README.md`](packages/cli/README.md) — CLI package architecture +- [`packages/build-infra/README.md`](packages/build-infra/README.md) — shared build tooling +- [`packages/package-builder/README.md`](packages/package-builder/README.md) — template-based package generation + ## See Also - [Socket API Reference](https://docs.socket.dev/reference) diff --git a/docs/build-guide.md b/docs/build-guide.md index 0c083a1da..3fef8abec 100644 --- a/docs/build-guide.md +++ b/docs/build-guide.md @@ -252,13 +252,13 @@ Assets are downloaded from [socket-btm](https://github.com/SocketDev/socket-btm) ```bash # Clear download cache -pnpm run clean-cache +pnpm run clean:cache # Clear CLI build cache pnpm --filter @socketsecurity/cli run clean # Clear all caches -pnpm clean +pnpm run clean ``` ### Environment Variables