Skip to content

README.md

Latest commit

 

History

History
142 lines (99 loc) · 5.64 KB

README.md

File metadata and controls

142 lines (99 loc) · 5.64 KB

Documentation Index

Welcome to the ai-todo documentation! This page provides a complete overview of all available documentation organized by category.

Quick Links

New to ai-todo? Start here:

Upgrading from v2.x?

Need help with a specific feature?

Documentation Structure

📘 user/ - User Guides

Essential guides for setting up and using ai-todo.

Document Description
MCP Setup Guide Cursor AI integration with MCP
Migration Guide Upgrading from shell script to Python

📚 guides/ - Feature Guides

Detailed guides for specific features and workflows.

Document Description
Getting Started Quick start guide with setup instructions
Installation Installation methods and troubleshooting
Usage Patterns Real-world usage scenarios and workflows
Numbering Modes Complete guide to task numbering modes
Coordination Setup Setup guides for coordination services
Tamper Detection File integrity protection
Beta Testing Testing pre-release versions
Security Best Practices .cursorignore and secrets protection

📝 examples/ - Usage Examples

Practical examples for specific features.

Document Description
Prune Examples Pruning old archived tasks - CLI and MCP examples

❓ FAQ

Document Description
FAQ Frequently asked questions

🏗️ design/ - Technical Design

Technical design specifications explaining system architecture and feature design.

Document Description
README Redesign v3.0 README structure design
Bug Reporting Design Bug reporting feature design
Git Hooks Design Git hooks integration design
Hybrid Task Numbering Task numbering system design
Migration System Migration system architecture
Multi-User Design Multi-user collaboration design
Smart Installer Smart installer design
Tagging System Task tagging system design
Uninstall Feature Uninstall feature design

👨‍💻 development/ - Contributor Documentation

Documentation for contributors and developers working on ai-todo.

Document Description
Development Guidelines Development workflow and best practices
Setup Development environment setup
Migration Guide Guide for writing migration functions
Test Plan Test plan for numbering modes
Tool Improvements Planned improvements and roadmap

🔬 analysis/ - Research and Analysis

Research documents, analysis reports, and comparison studies.

Document Description
CI/CD Process Parity CI/CD infrastructure assessment
Bash vs Zsh Analysis Shell comparison
Code Size Analysis Codebase optimization
GitHub API Coordination API coordination analysis

📦 archive/ - Historical Documentation

Completed migrations and deprecated documentation.

Document Description
Commit Format Migration Commit format migration (completed)
Cursor Rules Migration Cursor rules migration (completed)

Contributing Documentation

When adding new documentation:

  1. Choose the right category:

    • User essentials → user/
    • Feature guides → guides/
    • Technical designs → design/
    • Development docs → development/
    • Research/analysis → analysis/
    • Historical docs → archive/

  2. Use descriptive filenames:

    • Use UPPERCASE with underscores
    • Include document type suffix: _GUIDE.md, _DESIGN.md, _ANALYSIS.md

  3. Update this index:

    • Add your new document to the appropriate table above

  4. Cross-reference appropriately:

    • Link to related docs using relative paths

See STRUCTURE.md for complete documentation structure guidelines.

Need Help?

Repository: https://github.com/fxstein/ai-todo