yams/docs

YAMS Documentation Hub

Welcome to the comprehensive documentation for YAMS, a high-performance content-addressed storage system with advanced deduplication and semantic search capabilities.

🚀 Quick Start

• New to YAMS? → Installation Guide
• Ready to build? → Developer Quick Start
• Need API docs? → API Reference
• Looking for examples? → Examples & Tutorials

📚 Documentation Categories

👤 User Documentation

Perfect for end users, system administrators, and anyone deploying YAMS.

• Installation Guide - Complete setup instructions for all platforms
• User Guide - Using YAMS for document storage and search
• Configuration - System configuration and tuning
• Tutorials - Step-by-step guides and examples
• CLI Reference - Command-line tool documentation
• FAQ - Frequently asked questions

🛠️ Developer Documentation

Essential for contributors and anyone building on YAMS.

• Contributing Guide - How to contribute to YAMS
• Developer Setup - Development environment setup
• Architecture Overview - System design and components
• API Documentation - Complete API reference and examples
• Testing Guide - Testing strategies and coverage
• Build System - CMake configuration and build process

📄 Docs Build Tooling

Pandoc is required to build CLI manpages and to embed verbose --help documentation into the yams binary.

Install:

• macOS: brew install pandoc
• Ubuntu/Debian: sudo apt-get update && sudo apt-get install -y pandoc
• Fedora: sudo dnf install -y pandoc
• Arch: sudo pacman -S pandoc
• Windows: choco install pandoc or scoop install pandoc

🏗️ Architecture Documentation

Deep dives into YAMS system design and implementation.

• Core Architecture - Fundamental system design
• Storage Engine - Content-addressed storage
• Search System - Full-text and semantic search
• Compression - Multi-algorithm compression
• Security - Security design and considerations

🔧 Operations Documentation

Deployment, monitoring, and maintenance guides.

• Deployment Guide - Production deployment strategies
• Monitoring - Performance monitoring and alerting
• Backup & Recovery - See Deployment Guide and Troubleshooting
• Troubleshooting - Common issues and solutions
• Performance Tuning - Optimization best practices

📖 Feature Documentation

Core Features

• Content-Addressed Storage - SHA-256 based storage with deduplication
• Block-Level Deduplication - Efficient storage optimization
• Multi-Algorithm Compression - Zstandard and LZMA support
• Write-Ahead Logging - Crash recovery and data integrity

Search & AI Features

• Full-Text Search - SQLite FTS5 based text search
• Semantic Search - Vector-based similarity search
• Hybrid Search - Combined keyword and semantic search
• Document Extraction - Multi-format document processing

Integration Features

• MCP Server - Model Context Protocol for AI agents
• WebSocket Transport - Network communication
• CLI Tools - Command-line utilities
• REST API - HTTP API for remote access

🎯 Use Case Guides

• Document Management - Personal and enterprise document storage
• Knowledge Base - Building searchable knowledge repositories
• AI Integration - Connecting with LLMs and AI agents
• Data Archival - Long-term data preservation
• Content Deduplication - Storage optimization scenarios

🛡️ Quality Assurance

• Test Coverage Report - Current test coverage analysis
• Testing Strategy - Testing approach and standards
• Performance Benchmarks - Performance test results
• Security Audit - Security testing and validation

📊 Project Information

• Changelog - Version history and release notes
• Roadmap - Planned features and milestones
• License - Apache License 2.0 information
• Contributors - Project contributors and acknowledgments

🔗 External Resources

• GitHub Repository - Source code and issue tracking
• Release Downloads - Binary releases
• Community Forum - Questions and discussions
• Issue Tracker - Bug reports and feature requests

💡 Getting Help

Quick Help

• Check the FAQ for common questions
• Search the Troubleshooting Guide for known issues
• Browse GitHub Discussions for community support

Reporting Issues

1. Check existing GitHub Issues
2. Use the appropriate issue template
3. Provide detailed reproduction steps and system information
4. Include relevant log output and configuration

Contributing

1. Read the Contributing Guide
2. Set up your Development Environment
3. Follow the Code Standards
4. Submit a pull request with tests and documentation

📚 Documentation Standards

This documentation follows these principles:

• Clarity: Clear, concise explanations with practical examples
• Completeness: Comprehensive coverage of features and use cases
• Currency: Up-to-date with the latest YAMS version
• Accessibility: Easy navigation and search-friendly structure
• Quality: Tested examples and validated procedures

---

Last Updated: August 2025 | YAMS Version: 1.0.0 | Documentation Version: 1.0