README.md

SAI Documentation

Welcome to the SAI Software Management Suite documentation.

📚 Documentation Structure

This repository uses a monorepo structure with separate documentation for each package:

• docs/ - General documentation (you are here)
• sai/docs/ - SAI-specific documentation
• saigen/docs/ - SAIGEN-specific documentation

🚀 Getting Started

New Users

• When to Use What - Choose between SAI and SAIGEN
• Installation Guide - Install the tools
• Quick Start - Get up and running quickly

Existing Users

• Architecture Diagram - Understand the structure

📦 Package Documentation

SAI (Execution Tool)

See sai/docs/ for:

• CLI reference
• Configuration guide
• Provider documentation
• Examples and samples

SAIGEN (Generation Tool)

See saigen/docs/ for:

• CLI reference
• Repository management
• Generation engine
• Testing guide
• Examples and samples

🏗️ Architecture

• Architecture Diagram - Visual guide to the monorepo
• Monorepo Structure - Repository organization

📝 Implementation Summaries

The summaries/ directory contains detailed implementation notes and feature summaries created during development. These are useful for:

• Understanding implementation decisions
• Tracking feature development
• Technical deep dives

🔗 Quick Links

General

• Main README
• Quick Start Guide
• Release Checklist

SAI

• SAI Package README
• SAI Documentation

SAIGEN

• SAIGEN Package README
• SAIGEN Documentation

🆘 Need Help?

• Not sure which tool? → When to Use What
• Installation issues? → Installation Guide
• Found a bug? → Open an issue

📋 Archive

Obsolete documentation has been moved to archive/ for reference.