Practical overview
When it fits
Use DocChat when you want to query the contents of a documentation site conversationally instead of searching through its pages manually.
Who it is for
- People who need to find answers across a documentation website through natural-language questions.
- Developers evaluating or setting up a documentation-focused retrieval-augmented generation application.
Documented uses
- Turn a documentation URL into a searchable collection of its pages.
- Ask questions about indexed documentation and receive answers grounded in retrieved source material.
- Choose between embedding-based vector retrieval and a tree-based mode that does not require vector embeddings.
Requirements & limits
- The vector mode generates embeddings and uses Qdrant; the vectorless mode builds and searches a documentation tree.
- The crawler recursively visits internal pages up to configured limits and respects robots.txt.
- The local setup requires several components, including Docker services, a backend API and a background worker.
- The project describes reuse of existing indexed collections or trees when documentation URLs match.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Set up DocChat locally
Prepare the documented local application components for development.
Before you start
- Node.js (version 20 or later recommended)
- Docker
- pnpm
- The DocChat repository and backend environment values
Steps
Clone the repository and change into its directory.
Copy backend/.env.example to backend/.env and fill in the required variables.
Start the Docker services with docker compose up -d.
Install dependencies with pnpm at the repository root and again in backend/.
From backend/, run the documented Prisma migration and generate commands.
Expected outcome
The documented frontend, API server and background ingestion worker are started as separate local components.
Guide limitations
- The README points to a separate troubleshooting guide for the full environment-variable descriptions.
- This setup sequence does not establish that a particular documentation site can be crawled or that a query will succeed.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 18 October 2026
- Original website title
- avishek0769/DocChat · Official homepage title · retained in its source language

