Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

4.7 KB
Raw Blame

DeepTutor developer and agent handbook

Start here to install, diagnose, or change DeepTutor. This handbook describes the 1.7.0 source tree; use the documentation from the same tag when working on another release. The version authority is deeptutor/__version__.py. Commands below run from the repository root unless a page says otherwise.

Choose a reading path

Your task Read in order Completion evidence
Install and configure the app Agent setup → Storage Dependencies, module readiness, actual model response, reachable app
Fix an existing installation Setup troubleshooting → the relevant topic below Original failing action works in the same instance and workspace
Develop a change Development → Architecture → Testing Focused regression and applicable project checks
Add a tool or capability Tool and capability contracts → Modules Registration, availability, execution and terminal-result tests
Build a third-party extension Plugins → Runnable Learning Echo example Wheel, manifest, approval, worker and frontend checks
Investigate streaming or memory Events and progress → Runtime design Persistence/replay and cancellation evidence
Deploy or upgrade Modules → Containers → Storage Matching versions, retained data, readiness and a representative turn

For a terminal-capable agent, read this index, AGENTS.md, and the task's guide before editing. SKILL.md is the compact CLI reference. Inspect the checkout, working-tree changes, Python environment and runtime home before following an example. Keep existing user data and credentials separate from disposable test fixtures. Diagnose a failing installation before deciding to reinstall it.

Topic map

Runtime and extension development

Storage, deployment and feature contracts

Keeping this handbook useful

Keep one canonical page for each contract and link to it. Each topic should point to its implementation owners or regression tests. Update affected examples when commands, routes, ownership or storage change; generated schemas and module manifests take precedence over prose. Record what a check proves, including provider/network or platform limits.

Keep task plans, one-off test counts, screenshots, private paths, downloaded reference repositories and unrelated product research out of this handbook. Use PRs or local ignored output for execution evidence. A design proposal is not current behavior until its implementation can be located and verified.