Harvey Documentation Index

Overview

This document serves as the central hub for all Harvey documentation. It organizes all available guides, references, and specifications by category to help you find the information you need quickly.

Harvey’s documentation covers five main areas:

• Getting Started — Installation, setup, and basic usage
• User Guides — Practical instructions for using Harvey features
• Configuration & Architecture — Technical details and customization
• Development — Extending Harvey, testing, and contributing
• Reference — Technical specifications and API documentation

Quick Navigation

Documentation by Category

📚 Getting Started

These documents help you install and begin using Harvey.

🎯 User Guides

Practical guides for using Harvey’s features effectively.

⚙️ Configuration & Architecture

Technical details about Harvey’s internals and customization options.

🛠️ Development

Documents for developers extending, testing, or contributing to Harvey.

📋 Reference & Specifications

Technical specifications and reference materials.

📋 Installation Notes

Platform-specific installation instructions.

Documentation Map

harvey/
├── README.md                    # Project overview
├── INSTALL.md                   # Installation guide
├── about.md                     # Project metadata
├── user_manual.md               # User manual
├── getting_started.md           # Getting started guide
├── HARVEY.md                    # System prompt
│
├── CONFIGURATION.md             # Configuration reference
├── ARCHITECTURE.md              # Technical architecture
├── FOUNTAIN_FORMAT.md           # Fountain format spec
├── SKILLS.md                    # Skills system
├── ROUTING.md                   # Routing guide
├── KNOWLEDGE_BASE.md            # Knowledge base reference
├── SESSIONS.md                  # Session recording & Fountain
├── MODEL_CACHE.md               # Model capability caching
├── Using_RAGs_with_Harvey.md    # RAG comprehensive guide
├── TESTING.md                   # Testing guide
│
├── RAG_Support_Design.md         # RAG design document
├── delegate_to_harvey.md        # Delegation guide
├── model_testing_plan.md         # Model testing plan
├── models.md                    # Models reference
├── further_reading.md           # Additional resources
├── search.md                    # Search documentation
│
├── harvey.1.md                  # Man page
├── harvey.7.md                  # Additional man page
├── INSTALL_NOTES_macOS.md        # macOS install notes
└── INSTALL_NOTES_Windows.md      # Windows install notes

Recommended Reading Paths

For New Users

1. README.md — Understand what Harvey is and its philosophy
2. INSTALL.md — Get Harvey installed on your system
3. getting_started.md — Learn the basics through a walkthrough
4. user_manual.md — Reference for all slash commands

For Power Users

1. CONFIGURATION.md — Customize Harvey to your needs
2. SKILLS.md — Extend Harvey with custom skills
3. ROUTING.md — Set up remote endpoints
4. Using_RAGs_with_Harvey.md — Use RAG for enhanced responses
5. KNOWLEDGE_BASE.md — Build and query your knowledge base

For Developers

1. ARCHITECTURE.md — Understand Harvey’s internal structure
2. FOUNTAIN_FORMAT.md — Learn the session format
3. TESTING.md — Write and run tests
4. MODEL_CACHE.md — Understand model capability caching
5. RAG_Support_Design.md — RAG implementation details

For Advanced Use Cases

1. SESSIONS.md — Advanced session recording and replay
2. MODEL_CACHE.md — Model metadata and capability probing
3. model_testing_plan.md — Model evaluation methodologies

Document Statistics

Maintenance Notes

Documentation Standards

All Harvey documentation follows these conventions:

• Version tag in header: *Version X.Y — description*
• Overview section with bullet points for quick scanning
• Detailed sections with tables for complex information
• Examples section with code snippets where applicable
• Best Practices section for practical advice
• Troubleshooting section with common issues and solutions
• See Also section with links to related documents
• Generation note at bottom where applicable

Document Naming Convention

• Lowercase with hyphens only (e.g., Using_RAGs_with_Harvey.md)
• .md extension for all Markdown files
• .spmd extension for Harvey session recordings (Fountain format)

Auto-generated Files

The following files are auto-generated and should not be manually edited:

• INSTALL.md — Generated from codemeta.json using cmt tool
• about.md — Generated from codemeta.json using cmt tool
• harvey.1.md — Generated from harvey -help output
• Any *.html files — Generated from Markdown sources

Directory Structure

Currently all documentation files are located in the harvey/ directory root. For future organization, consider creating a harvey/docs/ subdirectory with symlinks or a structured hierarchy.

See Also

• README.md — Project overview
• ARCHITECTURE.md — Technical architecture
• CONFIGURATION.md — Configuration reference
• GitHub Repository — Source code and issues

Generated from Harvey source code and documentation analysis