Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

Gorev Documentation

Version: v0.16.0 Last Updated: October 5, 2025 Primary Language: English Secondary Language: Turkish (see Legacy Documentation)

📖 Overview

Welcome to the Gorev documentation! Gorev is a modern task management system designed for AI assistants (Claude, VS Code, Windsurf, Cursor) with MCP (Model Context Protocol) integration.

Key Features:

  • 🌐 Embedded Web UI (React + TypeScript)
  • 🗂️ Multi-Workspace Support (isolated databases per project)
  • 🤖 41 MCP Tools for AI integration
  • 📋 Template System with human-readable aliases
  • 🔌 REST API (23 Fiber endpoints)
  • 💻 VS Code Extension (optional)

🚀 Quick Navigation

New to Gorev

Start here → Quick Start Guide (10 minutes)

Installing Gorev

See → Installation Guide (platform-specific)

Upgrading from v0.15.x

Read → Migration Guide (15-30 minutes)

Having Issues

Check → Troubleshooting Guide (comprehensive solutions)

📚 Documentation Index

Getting Started

Guide Description Est. Time Audience
Quick Start Get up and running with Gorev 10 min All users
Installation Guide Platform-specific installation instructions 5 min All users
Troubleshooting Common issues and solutions As needed All users

Core Features

Guide Description Est. Time Audience
Web UI Guide Embedded React interface documentation 20 min Web UI users
Multi-Workspace Support Managing multiple isolated workspaces 15 min Advanced users
Template System Task templates and aliases 15 min All users
AI Context Management AI assistant integration 15 min AI users

Configuration & Setup

Guide Description Est. Time Audience
MCP Configuration Examples IDE setup guides (Claude, VS Code, Cursor, Windsurf) 10 min AI users
VS Code Extension Extension features and usage 15 min VS Code users
VS Code Export/Import Data migration guide 10 min VS Code users
Usage Guide Detailed usage examples 20 min All users

Reference Documentation

Reference Description Audience
MCP Tools Reference Complete reference for 41 MCP tools (Turkish) Developers
MCP Tools Reference (API) API documentation for MCP tools Developers

Development

Guide Description Audience
System Architecture Technical architecture details Developers
Contributing Guide How to contribute to Gorev Contributors
Development History Complete project history Developers
Roadmap Development roadmap and future plans All

Migration & Upgrades

Guide Description Est. Time Audience
v0.15 → v0.16 Migration Upgrade from v0.15.x to v0.16.0 15-30 min Existing users

Release Information (v0.16.0)

Document Description Audience
Bug Fixes Summary Critical bug fixes and improvements All users
Testing Guide Bug fix testing procedures Testers
Documentation Update Report Documentation changes Developers
Release Notes Full release documentation All users
Changelog Complete version history All users

🌍 Language Support

Primary Language: English

All new documentation (v0.16.0+) is written in English as the primary language. This includes:

  • Getting Started guides
  • Feature documentation
  • Reference documentation
  • Migration guides

Secondary Language: Turkish

Legacy Turkish documentation has been preserved in the legacy/tr/ directory:

Main README files:

AI Assistant Instructions:

📦 Documentation Structure

docs/
├── README.md                          # This file - Documentation index
├── guides/                            # User guides (English)
│   ├── getting-started/              # Getting started guides
│   │   ├── quick-start.md           # 10-minute quick start
│   │   ├── installation.md          # Installation guide
│   │   └── troubleshooting.md       # Troubleshooting guide
│   ├── features/                     # Feature documentation
│   │   ├── web-ui.md                # Web UI guide
│   │   ├── multi-workspace.md       # Multi-workspace guide
│   │   ├── template-system.md       # Template system guide
│   │   └── ai-context-management.md # AI context guide
│   ├── user/                         # User guides
│   │   ├── usage.md                 # Usage guide
│   │   ├── vscode-extension.md      # VS Code extension
│   │   └── vscode-data-export-import.md # Export/import
│   └── mcp-config-examples.md        # MCP configuration
├── legacy/                           # Legacy documentation
│   └── tr/                           # Turkish documentation (legacy)
│       ├── mcp-araclari.md          # MCP tools reference (TR)
│       ├── ornekler.md              # Usage examples (TR)
│       └── ... (other Turkish docs)
├── migration/                        # Migration guides
│   └── v0.15-to-v0.16.md            # v0.15 → v0.16 migration
├── architecture/                     # Architecture documentation
│   └── architecture-v2.md           # System architecture
├── development/                      # Development documentation
│   ├── TASKS.md                     # Development history
│   └── contributing.md              # Contributing guide
├── api/                             # API documentation
│   └── MCP_TOOLS_REFERENCE.md       # MCP API reference
└── releases/                        # Release documentation
    ├── v0.16.0_bug_fixes_summary.md
    └── RELEASE_NOTES_v0.16.0.md

🔍 Finding What You Need

By Role

End Users (Task Management)

  1. Start with Quick Start Guide
  2. Configure your AI assistant: MCP Configuration
  3. Learn templates: Template System
  4. Explore Web UI: Web UI Guide

VS Code Users

  1. Install extension: VS Code Extension Guide
  2. Set up workspace: Multi-Workspace Guide
  3. Export/import data: VS Code Export/Import

Developers (Contributing)

  1. Read architecture: System Architecture
  2. Review contributing guide: Contributing Guide
  3. Understand MCP tools: MCP Tools Reference
  4. Check development history: Development History

AI Assistant Users (Claude, Copilot, etc.)

  1. Configure MCP: MCP Configuration Examples
  2. Understand AI context: AI Context Management
  3. Learn MCP tools: MCP Tools Reference

By Task

Setting Up Gorev → Installation Guide → Quick Start

Managing Multiple Projects → Multi-Workspace Guide

Creating Structured Tasks → Template System Guide

Integrating with AI → AI Context Management → MCP Configuration

Troubleshooting Issues → Troubleshooting Guide

Upgrading Gorev → Migration Guide

📊 Documentation Stats

Category Files Total Words Status
Getting Started 3 ~25,000 ✅ Complete
Features 4 ~47,000 ✅ Complete
User Guides 3 ~15,000 ✅ Complete
Migration 1 ~8,000 ✅ Complete
Reference 2 ~30,000 ✅ Complete
Development 3 ~20,000 ✅ Complete
Total 16+ ~145,000 ✅ v0.16.0

🆘 Getting Help

Documentation Issues

Technical Support

Community

🔄 Version History

v0.16.0 (October 4, 2025) - Current

  • Embedded Web UI (React + TypeScript)
  • Multi-workspace support
  • REST API (23 endpoints)
  • Template aliases (bug, feature, research, etc.)
  • VS Code extension REST API migration
  • Documentation overhaul: 60,000+ words of new English documentation

v0.15.x (September 2025)

  • Advanced search & filtering (FTS5, fuzzy matching)
  • Filter profiles
  • Performance improvements

v0.14.x (August 2025)

  • Data export/import (JSON/CSV)
  • Enhanced error handling

v0.13.x (July 2025)

  • IDE extension management
  • Multi-IDE support

See ROADMAP.md for future plans.

📝 Contributing to Documentation

We welcome documentation contributions! Please see:

Documentation Checklist

  • Clear, concise writing
  • Code examples tested
  • Screenshots up-to-date
  • Links verified
  • Version info included
  • Last updated date current

📄 License

All documentation is released under the same MIT License as the Gorev project.

⬆ Back to Top

Made with ❤️ by the Gorev contributors

Documentation enhanced by Claude (Anthropic) - Your AI pair programming assistant