Skip to content

Commit 12ccac7

Browse files
committed
chore(docs): standardize build artifact structure and documentation organization
- Update .gitignore for build/dist standard (build=scratch, dist=distribution) - Remove global ignores for dist/, pkg/, target/ directories - Add specific patterns for build subdirectories (target, pkg, out, cmake, _deps, wasm) - Reorganize docs/ structure: move build-related docs to docs/build/ - Update docs/README.md with complete build documentation index - Fix verify-sea-transforms.mjs to use correct build/sea/ path
1 parent e5d4373 commit 12ccac7

File tree

8 files changed

+15
-5
lines changed

8 files changed

+15
-5
lines changed

.gitignore

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,22 @@ Thumbs.db
2121
**/.cache
2222
**/coverage
2323
**/.type-coverage
24-
**/dist
2524
**/build
2625
**/node_modules
2726
.build-checkpoints
28-
**/pkg
29-
**/target
3027
*.d.ts
3128
*.d.ts.map
3229
**/*.tmp
3330
*.tsbuildinfo
3431

32+
# Build artifacts (inside build/ only).
33+
**/build/target/
34+
**/build/pkg/
35+
**/build/out/
36+
**/build/cmake/
37+
**/build/_deps/
38+
**/build/wasm/
39+
3540
# Yarn PnP files (tests may create these)
3641
/.yarn
3742
/.pnp.cjs

docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,16 @@
2121
- [Unified binary design](architecture/unified-binary.md)
2222

2323
### Build System
24+
- [Build process overview](build/build-process.md)
25+
- [Build quick start](build/build-quick-start.md)
2426
- [Build system summary](build/build-system-summary.md)
27+
- [Build toolchain setup](build/build-toolchain-setup.md)
28+
- [Builds created](build/builds-created.md)
2529
- [Node.js build order](build/node-build-order-explained.md)
2630
- [Node.js build quick reference](build/node-build-quick-reference.md)
2731
- [Node.js patch creation guide](build/node-patch-creation-guide.md)
2832
- [Node.js patch metadata](build/node-patch-metadata.md)
33+
- [WASM build guide](build/wasm-build-guide.md)
2934

3035
### Configuration
3136
- [Configuration migration guide](configuration/configuration-migration.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

packages/node-sea-builder/scripts/verify-sea-transforms.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ function verifyPolyfill(code) {
8282
async function main() {
8383
const modifiedCliPath = path.join(
8484
__dirname,
85-
'../../..',
86-
'packages/dist/sea/cli-modified.js',
85+
'..',
86+
'build/sea/cli-modified.js',
8787
)
8888

8989
logger.log('SEA Transformation Verification')

0 commit comments

Comments
 (0)