Choose your path:
- Quick Start (10 min) — Essential setup and first contribution
- Detailed Guide — Complete end-to-end onboarding with troubleshooting
The detailed guide includes:
- Prerequisites and installation
- Development workflow
- Testing strategies
- Troubleshooting guide
📚 Documentation Organization Guide - Complete guide to Socket CLI's 3-tier documentation hierarchy
- architecture/ - System design documents and flow diagrams
- build/ - Node.js build system and patching documentation
- configuration/ - Shared configuration architecture
- development/ - Development tools and workflow
- guides/ - User-facing how-to guides
- performance/ - Performance optimization guides
- technical/ - Low-level implementation details
- testing/ - Testing strategies and guides
- Bootstrap/stub architecture
- Repository structure
- Stub execution flow
- Stub package
- Unified binary design
- Build System Guide - Start here - Complete build system overview
- Build/dist structure - Output directory structure
- Caching strategy - How build caching works
- WASM build guide - Building WASM packages
- Node.js build quick reference - Troubleshooting custom Node.js builds
- Node.js patch creation guide - Creating Socket patches for Node.js
- Node.js patch metadata - Patch metadata format
- Node.js build order - Understanding patch application order
- Getting started - Complete onboarding guide for new contributors
- Babel plugins
- Development linking
- Platform support
- Manifest management - Complete manifest API reference
- Manifest extensions - Proposed future features
- Metadata files - Metadata file formats
- Patch cacache - Patch backup and caching system