This repository contains the documentation for Altus 4 - AI-Enhanced MySQL Full-Text Search Engine.

Live Documentation: https://altus4.thavarshan.com/docs

This repository is automatically synchronized from the main altus4/core repository.

• Source: docs/ directory in the main repository
• Sync Trigger: Any push to main or develop branch that modifies documentation
• Last Sync: 2025-09-13 18:16:08 UTC
• Source Commit: 31af70c

Do not make direct changes to this repository!

To contribute to the documentation:

1. Fork the main repository
2. Make changes to the docs/ directory
3. Submit a pull request to the main repository
4. Changes will be automatically synced here upon merge

To work with the documentation locally:

# Clone the main repository
git clone https://github.com/altus4/core.git
cd altus4/docs

# Install dependencies
npm install

# Start development server
npm run docs:dev

# Build for production
npm run docs:build

• Setup Guide - Installation and deployment
• API Reference - Complete API documentation
• Architecture - System design and patterns
• Services - Service layer documentation
• Examples - Code examples and tutorials
• Development - Contributing guidelines
• Testing - Testing strategies and examples

This repository uses GitHub Actions for:

• Auto-sync from main repository
• Auto-build documentation site
• Auto-deploy to GitHub Pages

This documentation is part of the Altus 4 project. See the main repository for license information.