chore: consolidate Docs/ into docs/ (single documentation directory)
Move UML/ directory and Architecture.md from Docs/ to docs/. Rename Architecture.md to UML_ARCHITECTURE.md to avoid collision with existing docs/ARCHITECTURE.md (docs organization file). Update all references in README.md, CONTRIBUTING.md, CLAUDE.md, and the architecture file itself. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@@ -8,7 +8,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
|
||||
|
||||
**Version:** 3.3.0 | **Python:** 3.10+ | **Website:** https://skillseekersweb.com/
|
||||
|
||||
**Architecture:** See `Docs/Architecture.md` for UML diagrams and module overview. StarUML project at `Docs/UML/skill_seekers.mdj`.
|
||||
**Architecture:** See `docs/UML_ARCHITECTURE.md` for UML diagrams and module overview. StarUML project at `docs/UML/skill_seekers.mdj`.
|
||||
|
||||
## Essential Commands
|
||||
|
||||
|
||||
@@ -500,10 +500,10 @@ Skill_Seekers/
|
||||
|
||||
Full UML class diagrams are maintained in StarUML and synced from source code:
|
||||
|
||||
- **[Docs/Architecture.md](Docs/Architecture.md)** - Overview with embedded PNG diagrams
|
||||
- **[Docs/UML/skill_seekers.mdj](Docs/UML/skill_seekers.mdj)** - StarUML project (open with [StarUML](https://staruml.io/))
|
||||
- **[Docs/UML/exports/](Docs/UML/exports/)** - 14 PNG exports (package overview + 13 class diagrams)
|
||||
- **[Docs/UML/html/](Docs/UML/html/index.html/index.html)** - HTML API reference
|
||||
- **[docs/UML_ARCHITECTURE.md](docs/UML_ARCHITECTURE.md)** - Overview with embedded PNG diagrams
|
||||
- **[docs/UML/skill_seekers.mdj](docs/UML/skill_seekers.mdj)** - StarUML project (open with [StarUML](https://staruml.io/))
|
||||
- **[docs/UML/exports/](docs/UML/exports/)** - 14 PNG exports (package overview + 13 class diagrams)
|
||||
- **[docs/UML/html/](docs/UML/html/index.html/index.html)** - HTML API reference
|
||||
|
||||
**Key design patterns documented in UML:**
|
||||
- Strategy + Factory in Adaptors (SkillAdaptor ABC + 20+ implementations)
|
||||
|
||||
12
README.md
@@ -916,7 +916,7 @@ graph LR
|
||||
|
||||
The system is organized into **8 core modules** and **5 utility modules** (~200 classes total):
|
||||
|
||||

|
||||

|
||||
|
||||
| Module | Purpose | Key Classes |
|
||||
|--------|---------|-------------|
|
||||
@@ -931,7 +931,7 @@ The system is organized into **8 core modules** and **5 utility modules** (~200
|
||||
|
||||
Utility modules: **Parsers** (28 CLI parsers), **Storage** (S3/GCS/Azure), **Embedding** (multi-provider vectors), **Benchmark** (performance), **Utilities** (16 shared helpers).
|
||||
|
||||
Full UML diagrams: **[Docs/Architecture.md](Docs/Architecture.md)** | StarUML project: `Docs/UML/skill_seekers.mdj` | HTML API reference: `Docs/UML/html/`
|
||||
Full UML diagrams: **[docs/UML_ARCHITECTURE.md](docs/UML_ARCHITECTURE.md)** | StarUML project: `docs/UML/skill_seekers.mdj` | HTML API reference: `docs/UML/html/`
|
||||
|
||||
## 📋 Prerequisites
|
||||
|
||||
@@ -1201,10 +1201,10 @@ skill-seekers config --github
|
||||
- **[docs/QUICK_REFERENCE.md](docs/QUICK_REFERENCE.md)** - One-page cheat sheet
|
||||
|
||||
### Architecture
|
||||
- **[Docs/Architecture.md](Docs/Architecture.md)** - UML architecture overview with 14 diagrams
|
||||
- **[Docs/UML/exports/](Docs/UML/exports/)** - PNG diagram exports (package overview + 13 class diagrams)
|
||||
- **[Docs/UML/html/](Docs/UML/html/index.html/index.html)** - Full HTML API reference (all classes, operations, attributes)
|
||||
- **[Docs/UML/skill_seekers.mdj](Docs/UML/skill_seekers.mdj)** - StarUML project file (open with [StarUML](https://staruml.io/))
|
||||
- **[docs/UML_ARCHITECTURE.md](docs/UML_ARCHITECTURE.md)** - UML architecture overview with 14 diagrams
|
||||
- **[docs/UML/exports/](docs/UML/exports/)** - PNG diagram exports (package overview + 13 class diagrams)
|
||||
- **[docs/UML/html/](docs/UML/html/index.html/index.html)** - Full HTML API reference (all classes, operations, attributes)
|
||||
- **[docs/UML/skill_seekers.mdj](docs/UML/skill_seekers.mdj)** - StarUML project file (open with [StarUML](https://staruml.io/))
|
||||
|
||||
### Guides
|
||||
- **[docs/LARGE_DOCUMENTATION.md](docs/LARGE_DOCUMENTATION.md)** - Handle 10K-40K+ page docs
|
||||
|
||||
|
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 43 KiB After Width: | Height: | Size: 43 KiB |
|
Before Width: | Height: | Size: 486 KiB After Width: | Height: | Size: 486 KiB |
|
Before Width: | Height: | Size: 776 KiB After Width: | Height: | Size: 776 KiB |
|
Before Width: | Height: | Size: 439 KiB After Width: | Height: | Size: 439 KiB |
|
Before Width: | Height: | Size: 336 KiB After Width: | Height: | Size: 336 KiB |
|
Before Width: | Height: | Size: 129 KiB After Width: | Height: | Size: 129 KiB |
|
Before Width: | Height: | Size: 491 KiB After Width: | Height: | Size: 491 KiB |
|
Before Width: | Height: | Size: 214 KiB After Width: | Height: | Size: 214 KiB |
|
Before Width: | Height: | Size: 219 KiB After Width: | Height: | Size: 219 KiB |
|
Before Width: | Height: | Size: 261 KiB After Width: | Height: | Size: 261 KiB |
|
Before Width: | Height: | Size: 157 KiB After Width: | Height: | Size: 157 KiB |
|
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 127 KiB |
|
Before Width: | Height: | Size: 223 KiB After Width: | Height: | Size: 223 KiB |
|
Before Width: | Height: | Size: 8.6 KiB After Width: | Height: | Size: 8.6 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |