You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Refactor: Improve documentation structure and test organization
Based on code review findings, this commit addresses documentation structure
and testing organization to better align with the experimental nature of
auto-discovery and improve usability.
## Documentation Changes (README.md)
### 1. Restructured README Flow
- Moved "Quick Start" section to immediately follow "Features" (after line 45)
- Shows manual models.json setup first (primary/stable approach)
- Moved "Auto-Discovery" to end as "Advanced: Auto-Discovery (Experimental)"
- New position: After "Session & User Context Management" (line 453)
- Clearly marked as experimental opt-in feature
**Rationale:** Auto-discovery is experimental and should not be the first thing
users see. Manual configuration is the stable, proven approach.
### 2. Updated Features List
- Moved auto-discovery to bottom of list
- Changed from: "**Auto-Discovery: Automatically discover...**"
- Changed to: "**Advanced: Auto-Discovery (experimental)** - Automatically..."
- Updated test count: 166 → 198 tests
### 3. Added Edge Case Documentation
- Documented duplicate workflow names behavior
- Added warning: "If multiple workflows have the same name, only the last
discovered workflow will be available (last-wins behavior)"
- Recommendation: "Ensure your workflow names are unique"
**Addresses:** Self-review finding about undocumented edge case
## Testing Changes (Makefile)
### 1. Restructured Load Test Targets
**Before:**
```makefile
test-load → Manual models.json mode
test-load-discovery → Auto-discovery mode
test-all → Alias for test (redundant)
```
**After:**
```makefile
test-load → Runs both subtargets (umbrella)
├─ test-load-manual-config → Manual models.json mode
└─ test-load-discovery → Auto-discovery mode
```
**Benefits:**
- Single command `make test-load` now tests both modes
- Clear naming: "manual-config" vs "discovery"
- Removed redundant `test-all` alias
### 2. Updated Help Text
- Added `test-load` as umbrella target description
- Updated target names to reflect hierarchy
- Better alignment for readability
### 3. Removed Remaining Emojis
- Changed "✓" to "OK" in test output
- Changed "📊" prefix in file path messages
- Ensures consistency across codebase
## Impact
**No Breaking Changes:**
- All existing commands still work
- `make test` behavior unchanged
- `make test-load-discovery` still works independently
- Backward compatible
**Improved UX:**
- New users see stable approach first
- `make test-load` now tests both modes automatically
- Clear distinction between stable and experimental features
- Better organized help text
## Test Results
```
Test Suites: 11 passed, 11 total
Tests: 198 passed, 198 total
Coverage: 77.06% overall
```
All tests passing, no regressions introduced.
0 commit comments