forked from NuQloud/nc-talk-ai
34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
# Talk AI Documentation
|
|
|
|
Start with the root [README](../README.md) for the project overview.
|
|
|
|
## Overview
|
|
|
|
- [FEATURES.md](./FEATURES.md) — product surface and user-facing behavior
|
|
- [ARCHITECTURE.md](./ARCHITECTURE.md) — services, data model, and runtime flows
|
|
|
|
## Setup & Operations
|
|
|
|
- [QUICK_START.md](./QUICK_START.md) — install from source to first chat
|
|
- [BOT_SETUP_GUIDE.md](./BOT_SETUP_GUIDE.md) — admin configuration and bot creation
|
|
- [NATIVE_INTEGRATION.md](./NATIVE_INTEGRATION.md) — native Talk bot events (Talk 21+)
|
|
- [TROUBLESHOOTING.md](./TROUBLESHOOTING.md)
|
|
- [WEBHOOK_DEBUG_GUIDE.md](./WEBHOOK_DEBUG_GUIDE.md)
|
|
- [RAG_BACKGROUND_JOBS_GUIDE.md](./RAG_BACKGROUND_JOBS_GUIDE.md)
|
|
|
|
## Feature Guides
|
|
|
|
- [ONBOARDING.md](./ONBOARDING.md) — per-room onboarding and response modes
|
|
- [RAG_TOOL_GUIDE.md](./RAG_TOOL_GUIDE.md) — document search tool
|
|
- [SMART_PICKER_BOT_PROVIDER.md](./SMART_PICKER_BOT_PROVIDER.md) — "/" picker in Talk
|
|
- [pseudo_streaming.md](./pseudo_streaming.md) — chunked replies in Talk
|
|
|
|
## Extending
|
|
|
|
- [TOOL_PROVIDERS.md](./TOOL_PROVIDERS.md) — how companion apps contribute bot tools
|
|
- [DEVELOPMENT.md](./DEVELOPMENT.md) — build, test, and local verification
|
|
|
|
## Project
|
|
|
|
- [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
|