Skip to content
This repository was archived by the owner on Jun 17, 2026. It is now read-only.

Commit 4c17872

Browse files
montfortclaude
andcommitted
docs: update documentation for Model Orchestrator and Logger
README.md / README_ES.md: - Add "Intelligent Model Selection" feature section wiki/Configuration.md / Configuration.es.md: - Replace "Model" section with "Execution Mode" - Document Automatic, Economic, and Maximum Quality modes - Explain how Model Orchestrator classifies tasks - Update recommended configurations CLAUDE.md: - Add Logging section with mandatory logger usage rules - Document log levels (debug, info, warn, error) - Update architecture to include new files: - model-orchestrator.ts - logger.ts - context-manager.ts - context-storage.ts Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 67670cc commit 4c17872

5 files changed

Lines changed: 120 additions & 33 deletions

File tree

CLAUDE.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,11 @@ npm run build # Build producción (minificado)
2929
```
3030
src/
3131
├── main.ts # Entry point, registra comandos y vistas
32-
├── settings.ts # PluginSettingTab con config (API key, modelo, etc.)
32+
├── settings.ts # PluginSettingTab con config (API key, modo, etc.)
3333
├── claude-client.ts # Wrapper Anthropic SDK con streaming
3434
├── chat-view.ts # ItemView para panel lateral de chat
35+
├── model-orchestrator.ts # Enrutador inteligente de modelos
36+
├── logger.ts # Sistema de logging centralizado
3537
├── note-creator.ts # Modal para crear notas desde chat
3638
├── note-processor.ts # Procesamiento de notas existentes
3739
├── vault-indexer.ts # Indexación de bóveda
@@ -43,6 +45,8 @@ src/
4345
├── vault-actions.ts # Ejecutor de acciones sobre bóveda
4446
├── agent-mode.ts # Gestión del modo agente
4547
├── confirmation-modal.ts # Modal de confirmación de acciones
48+
├── context-manager.ts # Gestión de contexto de conversación
49+
├── context-storage.ts # Almacenamiento temporal de contexto
4650
├── i18n/ # Internationalization system
4751
│ ├── index.ts # Public API (t, setLocale, etc.)
4852
│ ├── types.ts # TypeScript types and translation keys
@@ -133,6 +137,45 @@ Example of adding German patterns:
133137
/^fortfahren$/i, // German: "proceed"
134138
```
135139

140+
## Logging
141+
142+
**CRITICAL: Never use `console.log`, `console.warn`, or `console.error` directly.**
143+
144+
All debug and error messages must use the centralized logger from `src/logger.ts`. This ensures:
145+
- Production builds only show warnings and errors (for user bug reports)
146+
- Development builds show all log levels for debugging
147+
- Consistent `[Claudian]` prefix across all messages
148+
149+
```typescript
150+
// ✅ Correct
151+
import { logger } from './logger';
152+
logger.debug('Orchestrator classified task as simple');
153+
logger.info('Context session initialized');
154+
logger.warn('Task classification failed, using fallback');
155+
logger.error('API Error:', error);
156+
157+
// ❌ Wrong - direct console usage
158+
console.log('[Claudian] Something happened');
159+
console.error('Error:', error);
160+
```
161+
162+
**Log levels:**
163+
164+
| Level | Production | Development | Use For |
165+
|-------|------------|-------------|---------|
166+
| `debug` | Hidden | Visible | Detailed flow, variable values, orchestrator decisions |
167+
| `info` | Hidden | Visible | Lifecycle events, successful operations, state changes |
168+
| `warn` | Visible | Visible | Recoverable errors, fallbacks, deprecated usage |
169+
| `error` | Visible | Visible | Failures, exceptions, critical issues |
170+
171+
**Guidelines:**
172+
- Use `debug` for information only developers need during development
173+
- Use `info` for notable events (migrations, session start/end)
174+
- Use `warn` for issues that don't break functionality but should be noted
175+
- Use `error` for failures that users might need to report
176+
177+
The `__DEV__` constant is injected at build time by esbuild to determine the environment.
178+
136179
## Documentation
137180

138181
**CRITICAL: README.md must always be in English.**

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ Process multiple notes at once with extraction templates:
6666
### 🗺️ Concept Maps
6767
Generate visual concept maps from selected notes, rendered in Mermaid format.
6868

69+
### 🧠 Intelligent Model Selection
70+
Automatic model orchestration routes each task to the optimal Claude model:
71+
- Simple tasks → Haiku (fast & economical)
72+
- Content creation → Sonnet (balanced)
73+
- Deep analysis → Opus (maximum quality)
74+
6975
### 🌍 Multilingual
7076
Full support for **English** and **Spanish**. More languages coming soon.
7177

README_ES.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ Procesa múltiples notas a la vez con plantillas de extracción:
6666
### 🗺️ Mapas de Conceptos
6767
Genera mapas de conceptos visuales a partir de notas seleccionadas, renderizados en formato Mermaid.
6868

69+
### 🧠 Selección Inteligente de Modelo
70+
Orquestación automática de modelos que enruta cada tarea al modelo óptimo de Claude:
71+
- Tareas simples → Haiku (rápido y económico)
72+
- Creación de contenido → Sonnet (equilibrado)
73+
- Análisis profundo → Opus (máxima calidad)
74+
6975
### 🌍 Multilingüe
7076
Soporte completo para **Inglés** y **Español**. Más idiomas próximamente.
7177

wiki/Configuration.es.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,35 @@ Obtén tu clave API en [console.anthropic.com](https://console.anthropic.com). L
3232

3333
---
3434

35-
### Modelo
35+
### Modo de Ejecución
3636

3737
| Ajuste | Descripción |
3838
|--------|-------------|
39-
| **Nombre** | Modelo |
40-
| **Descripción** | Modelo de Claude a usar para las respuestas |
41-
| **Por defecto** | Claude Sonnet 4 |
42-
| **Opciones** | Claude Sonnet 4, Claude Opus 4, Claude 3.5 Sonnet, Claude 3.5 Haiku |
39+
| **Nombre** | Modo de Ejecución |
40+
| **Descripción** | Cómo Claudian selecciona el modelo óptimo para cada tarea |
41+
| **Por defecto** | Automático |
42+
| **Opciones** | Automático, Económico, Máxima Calidad |
4343

44-
**Comparación de Modelos:**
44+
**Comparación de Modos:**
4545

46-
| Modelo | Mejor Para | Velocidad | Costo |
47-
|--------|------------|-----------|-------|
48-
| Claude Sonnet 4 | Uso general, rendimiento equilibrado | Rápido | Medio |
49-
| Claude Opus 4 | Razonamiento complejo, documentos largos | Más lento | Mayor |
50-
| Claude 3.5 Sonnet | Generación anterior, confiable | Rápido | Medio |
51-
| Claude 3.5 Haiku | Tareas rápidas, consultas simples | Más rápido | Menor |
46+
| Modo | Descripción | Mejor Para |
47+
|------|-------------|------------|
48+
| **Automático** | Haiku analiza cada tarea y la enruta al modelo óptimo | La mayoría de usuarios - equilibra costo y calidad |
49+
| **Económico** | Todas las tareas usan Haiku | Usuarios conscientes del presupuesto, tareas simples |
50+
| **Máxima Calidad** | Todas las tareas usan Opus | Razonamiento complejo, trabajo crítico |
51+
52+
**Cómo Funciona el Modo Automático:**
53+
54+
El Orquestador de Modelos usa Haiku (rápido y económico) para clasificar la complejidad de cada tarea:
55+
56+
| Complejidad | Modelo Usado | Tareas de Ejemplo |
57+
|-------------|--------------|-------------------|
58+
| Simple | Haiku 4.5 | Listar archivos, copiar, mover, eliminar, contenido placeholder |
59+
| Moderada | Sonnet 4 | Escribir contenido, resumir, traducir, explicar |
60+
| Compleja | Sonnet 4 | Operaciones multi-archivo, procesamiento batch, refactorización |
61+
| Profunda | Opus 4 | Análisis, planificación estratégica, síntesis de conocimiento |
62+
63+
Este enrutamiento inteligente optimiza costos mientras asegura calidad donde importa.
5264

5365
---
5466

@@ -308,15 +320,19 @@ Este archivo contiene tu configuración incluyendo la clave API. **No compartas
308320
## Configuración Recomendada
309321

310322
### Para Uso General
311-
- Modelo: Claude Sonnet 4
323+
- Modo de Ejecución: Automático
312324
- Tokens máximos: 4096
313325
- Confirmar acciones destructivas: Activado
314326

315327
### Para Bóvedas Grandes (1000+ notas)
328+
- Modo de Ejecución: Automático
316329
- Notas en contexto: 200-300
317330
- Tags en contexto: 100
318-
- Considera usar Claude Opus 4 para consultas complejas
319331

320-
### Para Tareas Rápidas
321-
- Modelo: Claude 3.5 Haiku
332+
### Para Usuarios Conscientes del Presupuesto
333+
- Modo de Ejecución: Económico
322334
- Tokens máximos: 2048
335+
336+
### Para Trabajo Crítico
337+
- Modo de Ejecución: Máxima Calidad
338+
- Tokens máximos: 8192

wiki/Configuration.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,23 +32,35 @@ Get your API key from [console.anthropic.com](https://console.anthropic.com). Th
3232

3333
---
3434

35-
### Model
35+
### Execution Mode
3636

3737
| Setting | Description |
3838
|---------|-------------|
39-
| **Name** | Model |
40-
| **Description** | Claude model to use for responses |
41-
| **Default** | Claude Sonnet 4 |
42-
| **Options** | Claude Sonnet 4, Claude Opus 4, Claude 3.5 Sonnet, Claude 3.5 Haiku |
39+
| **Name** | Execution Mode |
40+
| **Description** | How Claudian selects the optimal model for each task |
41+
| **Default** | Automatic |
42+
| **Options** | Automatic, Economic, Maximum Quality |
4343

44-
**Model Comparison:**
44+
**Mode Comparison:**
4545

46-
| Model | Best For | Speed | Cost |
47-
|-------|----------|-------|------|
48-
| Claude Sonnet 4 | General use, balanced performance | Fast | Medium |
49-
| Claude Opus 4 | Complex reasoning, long documents | Slower | Higher |
50-
| Claude 3.5 Sonnet | Previous generation, reliable | Fast | Medium |
51-
| Claude 3.5 Haiku | Quick tasks, simple queries | Fastest | Lower |
46+
| Mode | Description | Best For |
47+
|------|-------------|----------|
48+
| **Automatic** | Haiku analyzes each task and routes to the optimal model | Most users - balances cost and quality |
49+
| **Economic** | All tasks use Haiku | Budget-conscious users, simple tasks |
50+
| **Maximum Quality** | All tasks use Opus | Complex reasoning, critical work |
51+
52+
**How Automatic Mode Works:**
53+
54+
The Model Orchestrator uses Haiku (fast and cheap) to classify each task's complexity:
55+
56+
| Complexity | Model Used | Example Tasks |
57+
|------------|------------|---------------|
58+
| Simple | Haiku 4.5 | List files, copy, move, delete, placeholder content |
59+
| Moderate | Sonnet 4 | Write content, summarize, translate, explain |
60+
| Complex | Sonnet 4 | Multi-file operations, batch processing, refactoring |
61+
| Deep | Opus 4 | Analysis, strategic planning, knowledge synthesis |
62+
63+
This intelligent routing optimizes costs while ensuring quality where it matters.
5264

5365
---
5466

@@ -308,15 +320,19 @@ This file contains your configuration including the API key. **Do not share this
308320
## Recommended Configuration
309321

310322
### For General Use
311-
- Model: Claude Sonnet 4
323+
- Execution Mode: Automatic
312324
- Max tokens: 4096
313325
- Confirm destructive actions: On
314326

315327
### For Large Vaults (1000+ notes)
328+
- Execution Mode: Automatic
316329
- Notes in context: 200-300
317330
- Tags in context: 100
318-
- Consider using Claude Opus 4 for complex queries
319331

320-
### For Quick Tasks
321-
- Model: Claude 3.5 Haiku
332+
### For Budget-Conscious Users
333+
- Execution Mode: Economic
322334
- Max tokens: 2048
335+
336+
### For Critical Work
337+
- Execution Mode: Maximum Quality
338+
- Max tokens: 8192

0 commit comments

Comments
 (0)