Skip to content

Commit 9b81cad

Browse files
committed
docs: comprehensive documentation update — align all docs with current codebase state
- Fix license inconsistency: LICENSE.md now MIT (matches package.json) - Fix Node version drift: standardize on >=18 (v22 recommended) across all docs - Remove all 'stub agent' references from QUICKSTART, TESTING, ARCHITECTURE - Rewrite CONFIGURATION.md: replace obsolete axios/worker stub with actual AI service, preferences, and slash command configuration - Rewrite ELECTRON_README.md: replace outdated prototype doc with accurate overlay/chat/capture/coordinate architecture - Update ARCHITECTURE.md: fix fine grid spacing (25px not 50px), replace stub extensibility with actual provider/CLI/agent extension points - Update CONTRIBUTING.md: add characterization test workflow, expanded project structure with ai-service/, native/, hooks/ - Update PUBLISHING.md + RELEASE_PROCESS.md: version examples match 0.0.x cadence, add characterization test requirement - Update TESTING.md: replace Spectron/unit test stubs with current characterization test guidance - Update PROJECT_STATUS.md: reflect 0.0.14 and unreleased capability separation work - Add archival headers to FINAL_SUMMARY.txt, TEST_REPORT.md, GPT-reports.md, baseline-app.md - Add context headers to docs/inspect-overlay-plan.md, docs/INTEGRATED_TERMINAL_ARCHITECTURE.md - Add upstream separator in changelog.md between Liku Edition and upstream Copilot CLI entries - Fix README.md package size badge (196KB not 245KB), remove dead external doc link - Mark gameingwithai.md and refactored-ai-service.md with proper document-type headers
1 parent d0fc679 commit 9b81cad

21 files changed

+361
-483
lines changed

ARCHITECTURE.md

Lines changed: 15 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This application implements an Electron-based headless agent system with an ultr
1010
2. **Non-Intrusive**: Transparent overlay, edge-docked chat, never blocks user workspace
1111
3. **Performance-First**: Click-through by default, minimal background processing
1212
4. **Secure**: Context isolation, no Node integration in renderers, CSP headers
13-
5. **Extensible**: Clean IPC message schema ready for agent integration
13+
5. **Extensible**: Clean IPC message schema with multi-provider AI service and agent orchestration
1414

1515
## Multi-Agent Orchestration
1616

@@ -164,8 +164,8 @@ This allows internal seams to move without changing the external contract seen b
164164
```
165165

166166
**Key Functions:**
167-
- `generateCoarseGrid()`: Creates 100px spacing grid
168-
- `generateFineGrid()`: Creates 50px spacing grid
167+
- `generateCoarseGrid()`: Creates ~100px spacing grid
168+
- `generateFineGrid()`: Creates ~25px spacing grid
169169
- `renderDots()`: Renders interactive dots
170170
- `selectDot()`: Handles dot click events
171171
- `updateModeDisplay()`: Updates UI based on mode
@@ -367,49 +367,14 @@ All resources loaded locally, no CDN or external dependencies.
367367

368368
## Extensibility Points
369369

370-
### Agent Integration
371-
Replace stub in `src/main/index.js`:
372-
```javascript
373-
ipcMain.on('chat-message', async (event, message) => {
374-
// Call external agent API or worker process
375-
const response = await agent.process(message);
376-
chatWindow.webContents.send('agent-response', response);
377-
});
378-
```
379-
380-
### Custom Grid Patterns
381-
Add to overlay renderer:
382-
```javascript
383-
function generateCustomGrid(pattern) {
384-
// Implement custom dot placement logic
385-
}
386-
```
370+
### AI Service Providers
371+
New providers can be added by implementing the provider interface in `src/main/ai-service/providers/` and registering in the provider registry. The orchestration layer handles fallback chains and dispatch.
387372

388-
### Additional Windows
389-
Follow pattern:
390-
```javascript
391-
function createSettingsWindow() {
392-
settingsWindow = new BrowserWindow({
393-
webPreferences: {
394-
contextIsolation: true,
395-
nodeIntegration: false,
396-
preload: path.join(__dirname, 'preload.js')
397-
}
398-
});
399-
}
400-
```
373+
### CLI Commands
374+
New CLI commands are added as modules in `src/cli/commands/` and registered in the `COMMANDS` table in `src/cli/liku.js`.
401375

402-
### Plugin System (Future)
403-
```javascript
404-
// Example plugin interface
405-
const plugin = {
406-
name: 'screen-capture',
407-
init: (mainProcess) => {
408-
// Register IPC handlers
409-
ipcMain.on('capture-screen', plugin.captureScreen);
410-
}
411-
};
412-
```
376+
### Agent Roles
377+
New orchestration roles can be added as agent definition files in `.github/agents/` with corresponding hook policies in `.github/hooks/`.
413378

414379
## Platform Differences
415380

@@ -451,6 +416,12 @@ const plugin = {
451416
3. Enable IPC logging in DevTools
452417
4. Verify correct channel names
453418

419+
### AI Service Issues
420+
1. Check provider authentication (`/login` or environment variables)
421+
2. Verify model availability with `/status`
422+
3. Check capability routing with `/model`
423+
4. Review conversation state with `/status`
424+
454425
## Best Practices
455426

456427
### DO

0 commit comments

Comments
 (0)