# Where Is the Documentation for DeepTutor? A Complete Guide to Setup Guides and API References > Find DeepTutor documentation easily. Access setup guides API references and more directly within the HKUDS DeepTutor GitHub repository. - Repository: [✨Data Intelligence Lab@HKU✨/DeepTutor](https://github.com/HKUDS/DeepTutor) - Tags: api-reference - Published: 2026-04-08 --- **The documentation for DeepTutor is maintained as Markdown files inside the HKUDS/DeepTutor repository**, with the top-level [`README.md`](https://github.com/HKUDS/DeepTutor/blob/main/README.md) serving as the primary entry point and the `docs/` directory containing detailed user guides, configuration instructions, and data preparation workflows. DeepTutor is an open-source AI tutoring platform that embeds its documentation directly within the codebase. According to the repository structure, all guides are written in Markdown and render through the built-in documentation site when you launch the web UI, while remaining directly readable on GitHub. ## Primary Documentation Locations in the Repository Understanding where the documentation for DeepTutor resides requires examining four key locations that cover installation, configuration, usage patterns, and agent architecture. ### Project Overview and Installation (README.md) The top-level **[`README.md`](https://github.com/HKUDS/DeepTutor/blob/main/README.md)** file provides the essential starting point. Located at the repository root, this file explains the project's features, installation procedures, and quick-start commands required to launch DeepTutor. It contains the high-level overview necessary before diving into specific configuration steps. ### Comprehensive User Guides (docs/ Directory) The **`docs/`** folder houses the complete user guide and advanced configuration documentation. These files populate the built-in documentation site when running the web interface: - **[`docs/index.md`](https://github.com/HKUDS/DeepTutor/blob/main/docs/index.md)** – The home page of the documentation site, linking to all major sections - **[`docs/guide/pre-config.md`](https://github.com/HKUDS/DeepTutor/blob/main/docs/guide/pre-config.md)** – Environment variable setup and core configuration file preparation - **[`docs/guide/data-preparation.md`](https://github.com/HKUDS/DeepTutor/blob/main/docs/guide/data-preparation.md)** – Instructions for creating knowledge bases and preparing notebooks for the tutoring system According to the source code, these guides cover pre-configuration requirements and data preparation steps necessary before launching TutorBot capabilities. ### Command-Line Interface Reference (deeptutor_cli/README.md) For CLI-specific workflows, the **[`deeptutor_cli/README.md`](https://github.com/HKUDS/DeepTutor/blob/main/deeptutor_cli/README.md)** file documents command-line installation, usage patterns, and the complete command reference. This file explains how to execute one-shot commands and utilize the REPL interface. ### Agent Architecture and Skills (AGENTS.md) The **[`AGENTS.md`](https://github.com/HKUDS/DeepTutor/blob/main/AGENTS.md)** file at the repository root describes the built-in agents and skill templates used by TutorBot. This documentation covers the internal architecture, available capabilities, and how the system processes tutoring interactions. ## How to Access Documentation from the Command Line DeepTutor's CLI provides direct access to documentation through built-in help commands. These commands reference the same Markdown files stored in the repository: ```bash # Display top-level help (reads from README) deeptutor --help # Start interactive REPL with default chat capability deeptutor chat # Execute a one-shot query using documented command syntax deeptutor run chat "Explain the Fourier transform" -t rag --kb textbook # List available capabilities (documented in AGENTS.md) deeptutor plugin list ``` The CLI help system mirrors the content found in [`deeptutor_cli/README.md`](https://github.com/HKUDS/DeepTutor/blob/main/deeptutor_cli/README.md), ensuring consistency between the web documentation and terminal interfaces. ## Additional Documentation Files Beyond the primary guides, the repository includes specialized documentation for contributors: - **[`CONTRIBUTING.md`](https://github.com/HKUDS/DeepTutor/blob/main/CONTRIBUTING.md)** – Guidelines for contributors, development workflow, and contribution standards ## Summary - **The documentation for DeepTutor** is stored as Markdown files within the HKUDS/DeepTutor repository, not in a separate documentation website - **[`README.md`](https://github.com/HKUDS/DeepTutor/blob/main/README.md)** provides project overview, feature lists, and installation instructions - **`docs/`** contains detailed guides including [`index.md`](https://github.com/HKUDS/DeepTutor/blob/main/index.md) (home page), [`pre-config.md`](https://github.com/HKUDS/DeepTutor/blob/main/pre-config.md) (environment setup), and [`data-preparation.md`](https://github.com/HKUDS/DeepTutor/blob/main/data-preparation.md) (knowledge base management) - **[`deeptutor_cli/README.md`](https://github.com/HKUDS/DeepTutor/blob/main/deeptutor_cli/README.md)** serves as the comprehensive CLI reference manual - **[`AGENTS.md`](https://github.com/HKUDS/DeepTutor/blob/main/AGENTS.md)** documents TutorBot's built-in agents, skill templates, and architectural components - All documentation is accessible both through GitHub's interface and the built-in documentation site rendered by the web UI ## Frequently Asked Questions ### Where is the main documentation for DeepTutor located? The main documentation resides in the repository's **`docs/`** directory, specifically at [`docs/index.md`](https://github.com/HKUDS/DeepTutor/blob/main/docs/index.md), which serves as the home page. However, most users should start with the top-level **[`README.md`](https://github.com/HKUDS/DeepTutor/blob/main/README.md)** for installation instructions and project overview before proceeding to specialized guides. ### How do I configure environment variables in DeepTutor? Environment variables and core configuration files are documented in **[`docs/guide/pre-config.md`](https://github.com/HKUDS/DeepTutor/blob/main/docs/guide/pre-config.md)**. This file contains specific instructions for setting up required variables and preparing configuration files before running the application or CLI commands. ### What file contains the CLI command reference for DeepTutor? The complete CLI command reference is located in **[`deeptutor_cli/README.md`](https://github.com/HKUDS/DeepTutor/blob/main/deeptutor_cli/README.md)**. This documentation covers installation procedures, usage patterns, one-shot command syntax, and REPL interface options. The `--help` flag in the CLI also mirrors this content dynamically. ### Can I view DeepTutor documentation without running the application? Yes, all documentation files are standard Markdown format viewable directly on GitHub. You can read [`README.md`](https://github.com/HKUDS/DeepTutor/blob/main/README.md), [`docs/index.md`](https://github.com/HKUDS/DeepTutor/blob/main/docs/index.md), [`AGENTS.md`](https://github.com/HKUDS/DeepTutor/blob/main/AGENTS.md), and other guides in the repository without installing or running DeepTutor. The files are also rendered by the built-in documentation site when you do run the web UI.