@@ -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,21 @@ 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+ > - PHP helper functions (request_get, request_post, output formatters, etc.)
100+ > - Notification scripts (notify-github, notify-jira, notify-slack, etc.)
101+ > - Mock system (MockTrait, Self tests)
102+ > - Tooling tests
103+ >
104+ > ** → See ` .vortex/tooling/CLAUDE.md ` for complete documentation**
105+
106+ ### 4. .vortex/tests/ - Template Testing Harness
91107
92108** Purpose** : Comprehensive testing of the Vortex template itself through functional workflows
93109
@@ -121,7 +137,7 @@ cd tests && ./vendor/bin/phpunit # Run PHPUnit workflow tests
121137
122138## Testing Architecture Overview
123139
124- Vortex uses ** four independent testing systems** , each serving different parts of the codebase:
140+ Vortex uses ** five independent testing systems** , each serving different parts of the codebase:
125141
126142### 1. Documentation Tests (.vortex/docs/)
127143
@@ -161,7 +177,11 @@ Vortex uses **four independent testing systems**, each serving different parts o
161177- ** Handler tests** : Individual prompt and modification logic
162178- ** Fixture tests** : Expected vs actual template output
163179
164- ### 3. Template Tests (.vortex/tests/)
180+ ### 3. Tooling Tests (.vortex/tooling/)
181+
182+ > ** → See ` .vortex/tooling/CLAUDE.md ` ** for all tooling test documentation
183+
184+ ### 4. Template Tests (.vortex/tests/)
165185
166186** Scope** : Testing the actual Drupal template functionality
167187
@@ -179,7 +199,7 @@ Vortex uses **four independent testing systems**, each serving different parts o
179199- ** PHPUnit Functional** : End-to-end workflow testing
180200- ** BATS Unit** : Individual shell script testing with mocking
181201
182- ### 4 . Manual Integration Tests (.vortex/tests/manual/)
202+ ### 5 . Manual Integration Tests (.vortex/tests/manual/)
183203
184204** Scope** : Manual verification of notification integrations with real external services
185205
@@ -545,12 +565,13 @@ When script output changes, update corresponding test files:
545565
5465661 . ** Documentation** (` .vortex/docs/ ` ): Requires Node.js/Yarn
5475672 . ** Installer** (` .vortex/installer/ ` ): Requires PHP/Composer
548- 3 . ** Template** (` .vortex/tests/ ` ): Requires PHP/Composer + Node.js + BATS
568+ 3 . ** Tooling** (` .vortex/tooling/ ` ): Requires PHP/Composer
569+ 4 . ** Template** (` .vortex/tests/ ` ): Requires PHP/Composer + Node.js + BATS
549570
550571** Full Setup** (from ` .vortex/ ` ):
551572
552573``` bash
553- ahoy install # Installs dependencies for all three systems
574+ ahoy install # Installs dependencies for all four systems
554575```
555576
556577## Unified Testing Commands
@@ -559,13 +580,14 @@ For convenience, you can run tests across all systems:
559580
560581``` bash
561582# From .vortex/ root
562- ahoy install # Install all dependencies (docs, installer, template)
583+ ahoy install # Install all dependencies (docs, installer, tooling, template)
563584ahoy lint # Code linting across all systems
564585ahoy test # Run all template tests
565586
566587# Individual system commands
567588cd docs && yarn test # Documentation tests only
568589cd installer && composer test # Installer tests only
590+ cd tooling && ./vendor/bin/phpunit # Tooling tests only
569591cd tests && ./vendor/bin/phpunit # Template PHPUnit tests only
570592ahoy test-bats -- tests/bats/ # Template BATS tests only
571593```
@@ -1581,10 +1603,10 @@ throw new \RuntimeException(sprintf(
15811603# ## Cross-System Considerations
15821604
15831605- Each system can be modified independently
1584- - Changes to template (outside ` .vortex/` ) may require updates across all three systems
1606+ - Changes to template (outside ` .vortex/` ) may require updates across all four systems
15851607- Always run system-specific tests after making changes
15861608- Consider impact on user workflows when modifying any system
15871609
15881610---
15891611
1590- * This knowledge base should be updated whenever significant changes are made to any of the three Vortex subsystems or their maintenance procedures.*
1612+ * 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