Skip to content

Commit 3bd36d8

Browse files
committed
docs: reorganize documentation into logical categories
- Create new folders: build/, configuration/, performance/, testing/ - Move Node.js build docs to build/ folder - Move performance docs to performance/ folder - Move testing docs to testing/ folder - Move configuration docs to configuration/ folder - Remove history/ folder (archived historical docs) - Remove planning/ folder (diary/progress tracking docs) - Update docs/README.md to reflect new structure
1 parent 6f22b38 commit 3bd36d8

24 files changed

+43
-2806
lines changed

docs/README.md

Lines changed: 43 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,62 @@
22

33
## Organization
44

5-
- **guides/** - User-facing how-to guides for building and testing
65
- **architecture/** - System design documents and flow diagrams
7-
- **development/** - Development tools and build system docs
8-
- **history/** - Completed refactors and improvements (reference)
9-
- **planning/** - Future features and work in progress
6+
- **build/** - Node.js build system and patching documentation
7+
- **configuration/** - Shared configuration architecture
8+
- **development/** - Development tools and workflow
9+
- **guides/** - User-facing how-to guides
10+
- **performance/** - Performance optimization guides
1011
- **technical/** - Low-level implementation details
12+
- **testing/** - Testing strategies and guides
1113

1214
## Quick Links
1315

14-
### Building & Testing
15-
- [Build yao-pkg binary](guides/yao-pkg-build.md)
16-
- [Test yao-pkg binary](guides/testing-yao-pkg.md)
17-
- [CI setup for yao-pkg](guides/yao-pkg-ci.md)
18-
1916
### Architecture
2017
- [Bootstrap/stub architecture](architecture/bootstrap-stub.md)
21-
- [Unified binary design](architecture/unified-binary.md)
22-
- [Stub execution flow](architecture/stub-execution.md)
2318
- [Repository structure](architecture/repository.md)
19+
- [Stub execution flow](architecture/stub-execution.md)
20+
- [Stub package](architecture/stub-package.md)
21+
- [Unified binary design](architecture/unified-binary.md)
22+
23+
### Build System
24+
- [Build system summary](build/build-system-summary.md)
25+
- [Node.js build order](build/node-build-order-explained.md)
26+
- [Node.js build quick reference](build/node-build-quick-reference.md)
27+
- [Node.js patch creation guide](build/node-patch-creation-guide.md)
28+
- [Node.js patch metadata](build/node-patch-metadata.md)
29+
30+
### Configuration
31+
- [Configuration migration guide](configuration/configuration-migration.md)
32+
- [Configuration summary](configuration/configuration-summary.md)
33+
- [Shared configuration architecture](configuration/shared-configuration-architecture.md)
2434

2535
### Development
2636
- [Babel plugins](development/babel-plugins.md)
27-
- [Platform support](development/platform-support.md)
2837
- [Development linking](development/linking.md)
38+
- [Platform support](development/platform-support.md)
39+
40+
### Guides
41+
- [Build yao-pkg binary](guides/yao-pkg-build.md)
42+
- [CI setup for yao-pkg](guides/yao-pkg-ci.md)
43+
- [Test yao-pkg binary](guides/testing-yao-pkg.md)
44+
45+
### Performance
46+
- [Build performance](performance/performance-build.md)
47+
- [CI performance](performance/performance-ci.md)
48+
- [Testing performance](performance/performance-testing.md)
2949

3050
### Technical Details
51+
- [Build improvements (2025-10-15)](technical/build-improvements-2025-10-15.md)
52+
- [Build system improvements](technical/build-system-improvements.md)
3153
- [Cacache format](technical/cacache-format.md)
54+
- [Manifest extensions](technical/manifest-extensions.md)
3255
- [Manifest format](technical/manifest-format.md)
33-
- [Patch system](technical/patch-cacache.md)
34-
35-
### Planning & Future Work
36-
See [planning/README.md](planning/README.md) for planned features and work in progress.
56+
- [Manifest management](technical/manifest-management.md)
57+
- [Metadata files](technical/metadata-files.md)
58+
- [Patch cacache](technical/patch-cacache.md)
59+
60+
### Testing
61+
- [Local testing](testing/local-testing.md)
62+
- [Smart test selection](testing/smart-test-selection.md)
63+
- [Testing custom Node.js](testing/testing-custom-node.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/history/dry-refactor.md

Lines changed: 0 additions & 186 deletions
This file was deleted.

0 commit comments

Comments
 (0)