Skip to content

Momentry Core Documentation

Complete documentation for Momentry Core - Rust-based digital asset management system with video analysis and RAG capabilities.

๐Ÿ“š Quick Navigation

API Documentation

Location: /Users/accusys/momentry_core/docs_v1.0/API_WORKSPACE/

Comprehensive API reference for all Momentry Core endpoints.

Category Modules Description
Core APIs 01-19 Authentication, Register, Process, Search, Identity, etc.
New APIs 20-24 Service Management, Monitor, Trace Agent, VLM Search, Pose/Appearance
Studio Guides 21-26 Integration guides for Studio team

Quick Links: - API Documentation Index - Auth API - Search API

CLI Documentation

Location: /Users/accusys/momentry_core/docs_v1.0/CLI_WORKSPACE/

Command-line interface documentation for all Momentry CLI tools.

Categories: - File Processing: register, process, chunk, store-asrx, story - Vision & Detection: detect, vision, vectorize - Pipeline & Execution: phase1, complete - Media & Playback: play, watch - System & Administration: system, server, worker, query, status, backup - Lookup & Resolution: lookup, resolve, thumbnails - Agent: agent operations

Quick Links: - CLI Documentation Index - Register Command - Server Command

User Guides

Location: /Users/accusys/momentry_core/docs_v1.0/GUIDES/

User-friendly guides generated from API workspace modules.

Topics: - Getting Started - Video Processing - Identity Management - Search & Query - System Administration

Reference Documentation

Location: /Users/accusys/momentry_core/docs_v1.0/REFERENCE/

Data models, schemas, and technical references.

Contents: - Database schemas - Data structures - Configuration references - API response formats

Design Documentation

Location: /Users/accusys/momentry_core/docs_v1.0/DESIGN/

Architecture decisions and design documents.

Topics: - System architecture - V4.0 terminology changes - Faceโ†’Identity binding - Modular doc system - Database migration plans

Operations Documentation

Location: /Users/accusys/momentry_core/docs_v1.0/OPERATIONS/

Deployment, maintenance, and operations guides.

Topics: - Delivery procedure - LLM services configuration - Processor priority policy - Maintenance records - Backup and recovery

Integration Documentation

Location: /Users/accusys/momentry_core/docs_v1.0/INTEGRATIONS/

Integration guides and test results.

Topics: - n8n workflows - Studio integration - External API integrations - Test reports

๐Ÿš€ Quick Start

For API Users

  1. Browse API Documentation
  2. Check authentication requirements in 01_auth.md
  3. Start with 03_register.md for file registration

For CLI Users

  1. Browse CLI Documentation
  2. Check available commands by category
  3. Use momentry --help for quick reference

For Developers

  1. Check Design Documentation for architecture
  2. Review REFERENCE/ for data models
  3. Follow conventions in DOCUMENT_PATH_CONVENTIONS.md

For Operations

  1. Follow Delivery Procedure
  2. Check LLM Services for configuration
  3. Review maintenance records

๐Ÿ“‹ Documentation Standards

All documentation follows DOCUMENT_PATH_CONVENTIONS.md:

Required Elements

  • โœ… YAML frontmatter with title, version, date, author, status
  • โœ… Version history table
  • โœ… Absolute file paths (never relative)
  • โœ… PascalCase filenames for documents
  • โœ… Cross-references using absolute paths

Directory Conventions

Directory Purpose
API_WORKSPACE/ API design modules (source of truth)
CLI_WORKSPACE/ CLI command documentation
GUIDES/ User guides (generated from modules)
REFERENCE/ Data models and references
DESIGN/ Architecture and design docs
OPERATIONS/ Deployment and operations
INTEGRATIONS/ External integrations
M4_workspace/ M4 team communications

๐Ÿ” Search & Discovery

By Topic

Topic Primary Docs
Authentication API_WORKSPACE/modules/01_auth.md
File Registration API_WORKSPACE/modules/03_register.md
Video Processing API_WORKSPACE/modules/05_process.md
Search API_WORKSPACE/modules/06_search.md, 23_vlm_search_api.md
Identity Management API_WORKSPACE/modules/07_identity.md, 14_identity_history.md
Monitoring API_WORKSPACE/modules/21_monitor_api.md
Service Management API_WORKSPACE/modules/20_service_management_api.md

By File Pattern

# Find all API docs
ls /Users/accusys/momentry_core/docs_v1.0/API_WORKSPACE/modules/

# Find all CLI docs
ls /Users/accusys/momentry_core/docs_v1.0/CLI_WORKSPACE/modules/

# Find design docs
ls /Users/accusys/momentry_core/docs_v1.0/DESIGN/

๐Ÿ“– Documentation Maintenance

Adding New API Documentation

  1. Use template: API_WORKSPACE/modules/_template.md
  2. Follow naming convention: NN_topic.md (NN = order number)
  3. Add YAML frontmatter
  4. Include version history table
  5. Use absolute paths for all references

Adding New CLI Documentation

  1. Use template: CLI_WORKSPACE/modules/_template.md
  2. Follow naming convention: NNN_CLI_CommandName.md (NNN = 101-999)
  3. Include all required sections
  4. Provide practical examples

Updating Existing Documentation

  1. Check version history table
  2. Increment version number
  3. Add change entry
  4. Update date

๐Ÿ“ž Support

For Questions

  1. Check relevant documentation sections
  2. Review DESIGN/ for architecture
  3. Contact Core Team

For Issues

  1. Check OPERATIONS/ for troubleshooting
  2. Review maintenance records
  3. Submit issue to Git repository

๐Ÿ“Š Documentation Statistics

Metric Count
API Modules 31 files
CLI Commands 24 files
Design Docs 98 files
Operation Guides 46 files
Integration Docs 20 files
Total Files 219+ files

Version History

Version Date Changes
1.0 2026-10-24 Initial comprehensive documentation structure

Last Updated: 2026-10-24
Maintained By: Core Team