Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 2.55 KB

File metadata and controls

56 lines (38 loc) · 2.55 KB

ResearchOS Documentation

For Users

Getting Started

  • Getting Started — Prerequisites, environment setup, database, running the app
  • Deployment — VPS, Docker, Vercel+Railway deployment options

Architecture

Database

  • Schema Reference — All tables with columns, types, relationships, and ER overview
  • Migrations — Migration history and how to apply them
  • Conventions — Naming, JSONB patterns, ID formats, CamelModel mapping

API Reference

  • Overview — Base URL, error format, camelCase convention, CORS
  • Papers — Import, CRUD, BibTeX, PDF, metadata extraction, author linking
  • Websites — Website and GitHub repo endpoints
  • Projects — Projects, experiments, research questions, project notes
  • Tasks — Task columns, tasks, custom field definitions
  • Notes — Notes CRUD and AI generation across all scopes
  • Chat — AI copilot chat for papers, websites, repos, and notes
  • Search — Lexical/semantic search and library map
  • Agents — Workflows, runs, proposals, activity feed

Frontend

  • Routing — All routes with components and layout nesting
  • State Management — Context, localStorage, data fetching patterns
  • Components — Key shared components and their props

AI System

  • Agent Architecture — pydantic-ai setup, shared infrastructure, all workflows
  • AI Copilot — Chat copilot flows, agentic notes copilot, suggestion mechanism
  • Gap Analysis — Experiment gap detection, token budget, planning board

Developer Guides

Testing

  • Testing — Test strategy, running tests, CI setup