Skip to content

Commit d160500

Browse files
committed
docs: Update technical documentation to reflect modular structure
- Updated file paths in SETUP_ENHANCEMENT_PLAN.md to reference .conductor/conductor_setup/ - Updated all module locations in SETUP_TECHNICAL_IMPLEMENTATION.md - No user-facing documentation changes needed as functionality remains the same
1 parent 3f88aca commit d160500

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

SETUP_ENHANCEMENT_PLAN.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Transform setup into a predictable, fast experience with clear progress indicato
2525

2626
**Implementation**:
2727
```python
28-
# In setup.py
28+
# In .conductor/conductor_setup/ui_manager.py
2929
from rich.console import Console
3030
from rich.progress import Progress, BarColumn, TextColumn, TimeRemainingColumn
3131
from rich.panel import Panel
@@ -75,7 +75,7 @@ Expand detection accuracy from 90% to 95%+.
7575
- **Monorepo Tools**: Nx, Lerna, Rush, pnpm workspaces
7676
- **Databases**: PostgreSQL, MongoDB, Redis (via docker-compose.yml)
7777

78-
**Implementation** in detector.py:
78+
**Implementation** in .conductor/conductor_setup/detector.py:
7979
```python
8080
def detect_modern_frameworks(self) -> Dict[str, Any]:
8181
"""Detect cutting-edge frameworks and tools."""
@@ -127,7 +127,7 @@ Auto-configure for detected stacks - no questions asked.
127127

128128
**Implementation**:
129129
```python
130-
# In setup.py
130+
# In .conductor/conductor_setup/config_manager.py
131131
if detected_stack in COMMON_STACKS:
132132
# Express is the default - configure immediately
133133
config = EXPRESS_CONFIGS[detected_stack]
@@ -259,7 +259,7 @@ Cache everything to achieve sub-60-second setup times.
259259

260260
**Cache Strategy**:
261261
```python
262-
# In conductor_setup/cache_manager.py
262+
# In .conductor/conductor_setup/cache_manager.py
263263
class SetupCache:
264264
"""Cache detection results and API calls for speed."""
265265

SETUP_TECHNICAL_IMPLEMENTATION.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,16 @@
99
rich>=13.7.0 # Beautiful terminal UI
1010
```
1111

12-
**2. Update setup.py imports**:
12+
**2. Update imports in setup.py**:
1313
```python
14-
from rich.console import Console
15-
from rich.progress import Progress, SpinnerColumn, TextColumn, BarColumn
16-
from rich.panel import Panel
17-
from rich.tree import Tree
18-
from rich.table import Table
19-
from rich.syntax import Syntax
20-
from rich import box
14+
# These modules are now imported from the modular structure
15+
from conductor_setup.ui_manager import UIManager
16+
from conductor_setup.detector import TechnologyDetector
17+
from conductor_setup.config_manager import ConfigurationManager
18+
# Rich imports are handled within ui_manager.py
2119
```
2220

23-
**3. Create UIManager class in conductor_setup/ui_manager.py**:
21+
**3. Create UIManager class in .conductor/conductor_setup/ui_manager.py**:
2422
```python
2523
from rich.console import Console
2624
from rich.theme import Theme
@@ -76,7 +74,7 @@ class UIManager:
7674
self.console.print("Next: Run 'conductor tasks' to see available work.")
7775
```
7876

79-
**4. Update detector.py with determinate progress**:
77+
**4. Update .conductor/conductor_setup/detector.py with determinate progress**:
8078
```python
8179
def detect_technology_stack(self, ui: Optional[UIManager] = None) -> Dict[str, Any]:
8280
"""Detect technology stack with fast, cached results."""
@@ -129,7 +127,7 @@ def detect_technology_stack(self, ui: Optional[UIManager] = None) -> Dict[str, A
129127

130128
### New Detections to Add
131129

132-
**1. Modern Framework Detection in detector.py**:
130+
**1. Modern Framework Detection in .conductor/conductor_setup/detector.py**:
133131
```python
134132
def _detect_modern_frameworks(self) -> Dict[str, Any]:
135133
"""Detect modern web frameworks and tools."""
@@ -254,7 +252,7 @@ def _detect_test_frameworks(self) -> List[str]:
254252

255253
## Priority 3: Express Setup by Default
256254

257-
### Implementation in config_manager.py
255+
### Implementation in .conductor/conductor_setup/config_manager.py
258256

259257
```python
260258
# Define express configurations with stack patterns
@@ -367,7 +365,7 @@ def gather_configuration(self, stack_info: Dict, ui: UIManager) -> Dict[str, Any
367365

368366
## Priority 4: Interactive Preview
369367

370-
### Implementation in validator.py
368+
### Implementation in .conductor/conductor_setup/validator.py
371369

372370
```python
373371
def show_setup_preview(self, config: Dict[str, Any], ui: UIManager) -> None:
@@ -451,7 +449,7 @@ def _get_role_icon(self, role: str) -> str:
451449

452450
## Priority 5: Smart Error Recovery
453451

454-
### Create conductor_setup/error_handler.py
452+
### Create .conductor/conductor_setup/error_handler.py
455453

456454
```python
457455
from typing import Dict, Optional, Callable
@@ -524,7 +522,7 @@ class SmartErrorHandler:
524522

525523
## Priority 6: Aggressive Caching System
526524

527-
### Create conductor_setup/cache_manager.py
525+
### Create .conductor/conductor_setup/cache_manager.py
528526

529527
```python
530528
import json
@@ -605,7 +603,7 @@ def get_cache() -> SetupCache:
605603
### Cache Integration Points
606604

607605
```python
608-
# In detector.py
606+
# In .conductor/conductor_setup/detector.py
609607
def __init__(self, project_root: Path):
610608
self.project_root = project_root
611609
self.cache = get_cache()
@@ -622,7 +620,7 @@ def _get_project_hash(self) -> str:
622620

623621
return hasher.hexdigest()[:12]
624622

625-
# In github_integration.py
623+
# In .conductor/conductor_setup/github_integration.py
626624
def check_github_labels(self, repo: str) -> Dict[str, bool]:
627625
"""Check GitHub labels with caching."""
628626
return self.cache.get_or_compute(
@@ -631,7 +629,7 @@ def check_github_labels(self, repo: str) -> Dict[str, bool]:
631629
ttl=3600 # 1 hour cache
632630
)
633631

634-
# In config_manager.py
632+
# In .conductor/conductor_setup/config_manager.py
635633
def detect_common_patterns(self) -> Dict[str, Any]:
636634
"""Detect common project patterns with caching."""
637635
return self.cache.get_or_compute(

0 commit comments

Comments
 (0)