mirror of
https://github.com/crowetic/nc-talk-ai.git
synced 2026-09-07 07:32:31 +00:00
Pascal Kienast
43ba436a61
- Rewrite the four longest guides (RAG background jobs, webhook debug, bot setup, onboarding) at roughly half the length: drop historical bug-fix notes, duplicated command blocks, ASCII mega-diagrams and filler sections, keep everything operationally useful. - Remove provider-specific recommendations; examples are now neutral OpenAI-compatible endpoints. - Fix stale content: dead doc links in docs/README.md, old repo issue URLs, catalogue tools (now provided via the tool-provider extension point, not built-in), supported NC versions, clone URL in quick start. - Slim DEVELOPMENT.md down to build/test/migration essentials. docs/ shrinks from 2850 to 1278 lines with no loss of setup, debugging or architecture coverage.
Talk AI Documentation
Start with the root README for the project overview.
Overview
- FEATURES.md — product surface and user-facing behavior
- ARCHITECTURE.md — services, data model, and runtime flows
Setup & Operations
- QUICK_START.md — install from source to first chat
- BOT_SETUP_GUIDE.md — admin configuration and bot creation
- TROUBLESHOOTING.md
- WEBHOOK_DEBUG_GUIDE.md
- RAG_BACKGROUND_JOBS_GUIDE.md
Feature Guides
- ONBOARDING.md — per-room onboarding and response modes
- RAG_TOOL_GUIDE.md — document search tool
- SMART_PICKER_BOT_PROVIDER.md — "/" picker in Talk
- pseudo_streaming.md — chunked replies in Talk
Extending
- TOOL_PROVIDERS.md — how companion apps contribute bot tools
- DEVELOPMENT.md — build, test, and local verification