Skip to content

Commit 0f94ae9

Browse files
committed
docs: update build command references and consolidate docs
Update all documentation to reflect simplified build commands and remove references to deleted/outdated documentation. Changes: - Update CLAUDE.md with correct build commands - Update docs/README.md with new build doc structure - Remove references to deleted build docs - Update build/README.md cross-references Benefits: - Single source of truth for build documentation - All cross-references working correctly - Clear "start here" guidance for new contributors - 33% reduction in build-related docs without information loss
1 parent 722fd34 commit 0f94ae9

File tree

3 files changed

+17
-18
lines changed

3 files changed

+17
-18
lines changed

CLAUDE.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,10 @@ import colors from 'yoctocolors-cjs'
5151
## 🏗️ CLI-SPECIFIC
5252

5353
### Commands
54-
- **Build**: `npm run build` (alias for `npm run build:dist`)
54+
- **Build**: `pnpm build` (smart build with caching)
55+
- **Force rebuild**: `pnpm build --force` (rebuild everything)
56+
- **Build CLI only**: `pnpm build:cli` (just the CLI package)
57+
- **Watch mode**: `pnpm build:watch` or `pnpm dev`
5558
- **Test**: `npm run test` (check + all tests)
5659
- **Test unit**: `npm run test:unit` or `pnpm test:unit`
5760
- **Lint**: `npm run lint`, **Fix**: `npm run fix`
@@ -60,13 +63,13 @@ import colors from 'yoctocolors-cjs'
6063

6164
### Testing Best Practices
6265
- **🚨 NEVER USE `--` BEFORE TEST FILE PATHS** - Runs ALL tests!
63-
- **Always build first**: `pnpm build:dist:src`
66+
- **Always build first**: `pnpm build:cli` (or `pnpm build:cli`)
6467
- **Single file**: `pnpm test:unit src/commands/file.test.mts`
6568
- **With pattern**: `pnpm test:unit src/commands/file.test.mts -t "pattern"`
6669
- **Update snapshots**: `pnpm testu` or `pnpm testu <file>`
6770

6871
### Running CLI Locally
69-
- **Build + run**: `npm run build && npm exec socket`
72+
- **Build + run**: `pnpm build:cli && pnpm exec socket`
7073
- **Quick**: `npm run bs` (builds source only, then runs)
7174
- **No build**: `npm run s`
7275
- **Native TS**: `./sd` (Node 22+ with native TypeScript)

docs/README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,14 @@ Complete end-to-end onboarding for new contributors:
3636
- [Unified binary design](architecture/unified-binary.md)
3737

3838
### Build System
39-
- [Build/dist structure and archiving](build/build-dist-structure.md)
40-
- [Build process overview](build/build-process.md)
41-
- [Build quick start](build/build-quick-start.md)
42-
- [Build system summary](build/build-system-summary.md)
43-
- [Build toolchain setup](build/build-toolchain-setup.md)
44-
- [Builds created](build/builds-created.md)
45-
- [Node.js build order](build/node-build-order-explained.md)
46-
- [Node.js build quick reference](build/node-build-quick-reference.md)
47-
- [Node.js patch creation guide](build/node-patch-creation-guide.md)
48-
- [Node.js patch metadata](build/node-patch-metadata.md)
49-
- [WASM build guide](build/wasm-build-guide.md)
39+
- [Build System Guide](build/README.md) - **Start here** - Complete build system overview
40+
- [Build/dist structure](build/build-dist-structure.md) - Output directory structure
41+
- [Caching strategy](build/caching-strategy.md) - How build caching works
42+
- [WASM build guide](build/wasm-build-guide.md) - Building WASM packages
43+
- [Node.js build quick reference](build/node-build-quick-reference.md) - Troubleshooting custom Node.js builds
44+
- [Node.js patch creation guide](build/node-patch-creation-guide.md) - Creating Socket patches for Node.js
45+
- [Node.js patch metadata](build/node-patch-metadata.md) - Patch metadata format
46+
- [Node.js build order](build/node-build-order-explained.md) - Understanding patch application order
5047

5148
### Configuration
5249
- [Configuration migration guide](configuration/configuration-migration.md)
@@ -60,7 +57,6 @@ Complete end-to-end onboarding for new contributors:
6057
- [Platform support](development/platform-support.md)
6158

6259
### Guides
63-
- [Build yao-pkg binary](guides/yao-pkg-build.md)
6460
- [CI setup for yao-pkg](guides/yao-pkg-ci.md)
6561
- [Test yao-pkg binary](guides/testing-yao-pkg.md)
6662

@@ -70,8 +66,6 @@ Complete end-to-end onboarding for new contributors:
7066
- [Testing performance](performance/performance-testing.md)
7167

7268
### Technical Details
73-
- [Build improvements (2025-10-15)](technical/build-improvements-2025-10-15.md)
74-
- [Build system improvements](technical/build-system-improvements.md)
7569
- [Cacache format](technical/cacache-format.md)
7670
- [Manifest extensions](technical/manifest-extensions.md)
7771
- [Manifest format](technical/manifest-format.md)

docs/build/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,9 @@ node scripts/extract-yoga-wasm.mjs
301301

302302
### Building Custom Node.js Binaries
303303

304-
See the comprehensive [yao-pkg Build Guide](../guides/yao-pkg-build.md) for building custom Node.js binaries with Socket patches.
304+
For building custom Node.js binaries with Socket patches, see:
305+
- [Node.js Build Quick Reference](node-build-quick-reference.md)
306+
- [Node.js Patch Creation Guide](node-patch-creation-guide.md)
305307

306308
### Platform-Specific Builds
307309

0 commit comments

Comments
 (0)