Skip to content

Commit 5734a2e

Browse files
committed
docs(node-smol-builder): organize compression docs into wasm-bundle tier-3 structure
- Move cross-platform-compression.md to wasm-bundle/docs/ (tier-3) - Move macho-compression.md to wasm-bundle/docs/ (tier-3) - Add package-level docs/README.md with overview and links (tier-2) - Establish clear separation between package docs (tier-2) and sub-package implementation docs (tier-3)
1 parent b4c29f6 commit 5734a2e

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# node-smol-builder Documentation
2+
3+
Package-level documentation for the Socket custom Node.js binary builder.
4+
5+
## Overview
6+
7+
This package builds a custom Node.js v24.10.0 binary from source with Socket security patches, Brotli compression support, SEA support, and bootstrap integration.
8+
9+
## Contents
10+
11+
Future package-level documentation will be added here for:
12+
- Build process overview and configuration
13+
- Socket patch architecture and versioning
14+
- Cross-platform build considerations
15+
- Upstream Node.js tracking and update process
16+
17+
## Sub-Package Documentation
18+
19+
- **wasm-bundle/** - Rust WASM compression module
20+
- [Cross-Platform Compression](../wasm-bundle/docs/cross-platform-compression.md) - WASM-based binary compression without UPX
21+
- [macOS Binary Compression](../wasm-bundle/docs/macho-compression.md) - macOS-specific Mach-O compression
22+
23+
## Quick Links
24+
25+
- **Main README**: `../README.md`
26+
- **Quickstart**: `../QUICKSTART-COMPRESSION.md`
27+
- **Test Results**: `../TEST-RESULTS.md`
28+
- **Build Scripts**: `../scripts/`
29+
30+
## Build Output
31+
32+
- **Location**: `build/out/Release/`
33+
- **Files**: `node` (custom Node.js binary with Socket patches)
34+
- **Platforms**: Currently builds for host platform only
35+
36+
## Upstream
37+
38+
- **Repository**: https://github.com/nodejs/node
39+
- **Version**: v24.10.0
40+
- **Socket Patches**: `../patches/socket/`
41+
- **License**: MIT

packages/node-smol-builder/docs/cross-platform-compression.md renamed to packages/node-smol-builder/wasm-bundle/docs/cross-platform-compression.md

File renamed without changes.

packages/node-smol-builder/docs/macho-compression.md renamed to packages/node-smol-builder/wasm-bundle/docs/macho-compression.md

File renamed without changes.

0 commit comments

Comments
 (0)