37 lines
1.9 KiB
Markdown
37 lines
1.9 KiB
Markdown
# Veskslop documentation index
|
|
|
|
This file lists the project documents.
|
|
|
|
## Design documents
|
|
|
|
| Document | Scope |
|
|
| --- | --- |
|
|
| [architecture.md](architecture.md) | System parts, boundaries, and data flow |
|
|
| [core-bridge.md](core-bridge.md) | The Vesktop-side capability layer |
|
|
| [daemon.md](daemon.md) | The external MCP daemon |
|
|
| [webui.md](webui.md) | The web control UI and its JSON API |
|
|
| [voice.md](voice.md) | Voice state reads, planned actions, and lifecycle |
|
|
| [media.md](media.md) | Media archive: command, storage, limits, and Web UI |
|
|
| [media-scraper.md](media-scraper.md) | The scrape engine: backends, walk, pacing, schema |
|
|
| [media-mcp.md](media-mcp.md) | The media MCP tool surface |
|
|
| [slopbot.md](slopbot.md) | The dedicated bot core for media scraping |
|
|
| [agent.md](agent.md) | The local LLM harness and remote MCP agent access |
|
|
| [communication.md](communication.md) | Trust model, commands, and the trigger log |
|
|
| [auth.md](auth.md) | QR login and token persistence |
|
|
| [testing.md](testing.md) | Tests and the live test setup |
|
|
| [decisions.md](decisions.md) | Design decisions and their reasons |
|
|
| [ui-changes.md](ui-changes.md) | The Nocturne fidelity pass over the web UI (third-party writeup) |
|
|
|
|
## Documents outside `docs/`
|
|
|
|
| File | Scope |
|
|
| --- | --- |
|
|
| [../AGENTS.md](../AGENTS.md) | Agent entry point, guardrails, resume checklist |
|
|
| [../CURRENT.md](../CURRENT.md) | Live session state |
|
|
| [../TODO.md](../TODO.md) | Ordered backlog |
|
|
| [../poc/README.md](../poc/README.md) | Spike and daemon run commands |
|
|
| [../media-scrape/README.md](../media-scrape/README.md) | Media scrape module layout |
|
|
| [../microslopsam/README.md](../microslopsam/README.md) | Bundled MicroslopSam SAPI4 TTS engine integration |
|
|
| [../TTS-DESIGN.md](../TTS-DESIGN.md) | Integration contract for an external TTS engine |
|
|
| [../README.md](../README.md) | Project introduction |
|