@@ -15,8 +15,10 @@ vortex/
1515├── .vortex/ # Test harness and development tools
1616│ ├── docs/ # Documentation for Vortex
1717│ ├── installer/ # Self-contained Symfony console installer
18+ │ ├── tooling/ # PHP helpers and notification scripts
19+ │ │ └── CLAUDE.md # Tooling documentation (see this for tooling work)
1820│ ├── tests/ # Unit and functional tests
19- │ └── CLAUDE.md # This maintenance guide
21+ │ └── CLAUDE.md # This maintenance guide
2022└── [root files] # The actual Drupal template
2123 └── CLAUDE.md # Drupal development guide
2224```
@@ -25,7 +27,7 @@ vortex/
2527
2628## .vortex Directory Structure
2729
28- The ` .vortex/ ` directory contains ** three distinct subsystems** , each with its own purpose and technology stack:
30+ The ` .vortex/ ` directory contains ** four distinct subsystems** , each with its own purpose and technology stack:
2931
3032### 1. .vortex/docs/ - Documentation Website
3133
@@ -87,7 +89,22 @@ composer install # Install dependencies
8789UPDATE_FIXTURES=1 composer test # Update test fixtures
8890```
8991
90- ### 3. .vortex/tests/ - Template Testing Harness
92+ ### 3. .vortex/tooling/ - Notification & Helper Scripts
93+
94+ ** Purpose** : Reusable PHP helper functions and notification scripts for Vortex operations
95+
96+ > ** ⚠️ ALL TOOLING DOCUMENTATION IS IN ` .vortex/tooling/CLAUDE.md ` **
97+ >
98+ > For ANY work related to:
99+ >
100+ > - PHP helper functions (request_get, request_post, output formatters, etc.)
101+ > - Notification scripts (notify-github, notify-jira, notify-slack, etc.)
102+ > - Mock system (MockTrait, Self tests)
103+ > - Tooling tests
104+ >
105+ > ** → See ` .vortex/tooling/CLAUDE.md ` for complete documentation**
106+
107+ ### 4. .vortex/tests/ - Template Testing Harness
91108
92109** Purpose** : Comprehensive testing of the Vortex template itself through functional workflows
93110
@@ -121,7 +138,7 @@ cd tests && ./vendor/bin/phpunit # Run PHPUnit workflow tests
121138
122139## Testing Architecture Overview
123140
124- Vortex uses ** four independent testing systems** , each serving different parts of the codebase:
141+ Vortex uses ** five independent testing systems** , each serving different parts of the codebase:
125142
126143### 1. Documentation Tests (.vortex/docs/)
127144
@@ -161,7 +178,11 @@ Vortex uses **four independent testing systems**, each serving different parts o
161178- ** Handler tests** : Individual prompt and modification logic
162179- ** Fixture tests** : Expected vs actual template output
163180
164- ### 3. Template Tests (.vortex/tests/)
181+ ### 3. Tooling Tests (.vortex/tooling/)
182+
183+ > ** → See ` .vortex/tooling/CLAUDE.md ` ** for all tooling test documentation
184+
185+ ### 4. Template Tests (.vortex/tests/)
165186
166187** Scope** : Testing the actual Drupal template functionality
167188
@@ -179,7 +200,7 @@ Vortex uses **four independent testing systems**, each serving different parts o
179200- ** PHPUnit Functional** : End-to-end workflow testing
180201- ** BATS Unit** : Individual shell script testing with mocking
181202
182- ### 4 . Manual Integration Tests (.vortex/tests/manual/)
203+ ### 5 . Manual Integration Tests (.vortex/tests/manual/)
183204
184205** Scope** : Manual verification of notification integrations with real external services
185206
@@ -545,12 +566,13 @@ When script output changes, update corresponding test files:
545566
5465671 . ** Documentation** (` .vortex/docs/ ` ): Requires Node.js/Yarn
5475682 . ** Installer** (` .vortex/installer/ ` ): Requires PHP/Composer
548- 3 . ** Template** (` .vortex/tests/ ` ): Requires PHP/Composer + Node.js + BATS
569+ 3 . ** Tooling** (` .vortex/tooling/ ` ): Requires PHP/Composer
570+ 4 . ** Template** (` .vortex/tests/ ` ): Requires PHP/Composer + Node.js + BATS
549571
550572** Full Setup** (from ` .vortex/ ` ):
551573
552574``` bash
553- ahoy install # Installs dependencies for all three systems
575+ ahoy install # Installs dependencies for all four systems
554576```
555577
556578## Unified Testing Commands
@@ -559,13 +581,14 @@ For convenience, you can run tests across all systems:
559581
560582``` bash
561583# From .vortex/ root
562- ahoy install # Install all dependencies (docs, installer, template)
584+ ahoy install # Install all dependencies (docs, installer, tooling, template)
563585ahoy lint # Code linting across all systems
564586ahoy test # Run all template tests
565587
566588# Individual system commands
567589cd docs && yarn test # Documentation tests only
568590cd installer && composer test # Installer tests only
591+ cd tooling && ./vendor/bin/phpunit # Tooling tests only
569592cd tests && ./vendor/bin/phpunit # Template PHPUnit tests only
570593ahoy test-bats -- tests/bats/ # Template BATS tests only
571594```
@@ -1581,10 +1604,10 @@ throw new \RuntimeException(sprintf(
15811604# ## Cross-System Considerations
15821605
15831606- Each system can be modified independently
1584- - Changes to template (outside ` .vortex/` ) may require updates across all three systems
1607+ - Changes to template (outside ` .vortex/` ) may require updates across all four systems
15851608- Always run system-specific tests after making changes
15861609- Consider impact on user workflows when modifying any system
15871610
15881611---
15891612
1590- * This knowledge base should be updated whenever significant changes are made to any of the three Vortex subsystems or their maintenance procedures.*
1613+ * This knowledge base should be updated whenever significant changes are made to any of the four Vortex subsystems or their maintenance procedures.*
0 commit comments