This folder contains the primary documentation for Condense. Use it as a practical guide for understanding the product, integrating it into an application, and contributing changes.
- overview.md — What Condense does, why it exists, and the main optimization modes
- api.md — Integration options for the SDK, HTTP API, and CLI
- examples.md — Ready-to-use code snippets for common workflows
- architecture.md — How the request flow and service layers are organized
- cli.md — Command-line usage, options, and batch processing patterns
- development.md — Local setup, testing, linting, and contribution expectations
- configuration.md — Configuration options, environment variables, and request parameters
- troubleshooting.md — Common issues and how to diagnose them
- deployment.md — Production deployment considerations for servers and serverless environments
- faq.md — Common questions and practical answers
- ../README.md — Project overview and installation instructions
- ../MIGRATION_GUIDE.md — Version-to-version upgrade guidance
- ../SECURITY.md — Supported versions and security policy
- ../COMMANDS.md — Supported CLI commands