# CharleOS

## Docs

- [Changelog](https://docs.charle.agency/changelog.md): Product updates and release notes for CharleOS
- [Billing Examples](https://docs.charle.agency/concepts/billing/billing-examples.md): Worked examples showing how billing calculations work in practice
- [Billing Model](https://docs.charle.agency/concepts/billing/billing-model.md): How value-based billing works in CharleOS
- [Hour Rollover](https://docs.charle.agency/concepts/billing/hour-rollover.md): How hours carry over between months when work exceeds budget
- [Overview](https://docs.charle.agency/concepts/billing/index.md): How billing and pricing works in CharleOS
- [Retainer Plans](https://docs.charle.agency/concepts/billing/retainer-plans.md): How monthly retainer plans work in CharleOS
- [Overview](https://docs.charle.agency/concepts/estimation/index.md): How work estimation works in CharleOS
- [Scoping](https://docs.charle.agency/concepts/estimation/scoping.md): How to scope work effectively for accurate estimates
- [T-shirt Sizing](https://docs.charle.agency/concepts/estimation/t-shirt-sizing.md): How to estimate work using standardized time ranges
- [Capacity](https://docs.charle.agency/concepts/financial/capacity.md): How available working time is calculated and allocated in CharleOS
- [Day Rates](https://docs.charle.agency/concepts/financial/day-rates.md): How revenue per day is calculated and tracked in CharleOS
- [Efficiency](https://docs.charle.agency/concepts/financial/efficiency.md): How delivery performance is measured against estimates in CharleOS
- [Overview](https://docs.charle.agency/concepts/financial/index.md): Understanding CharleOS financial metrics and performance tracking
- [Utilisation](https://docs.charle.agency/concepts/financial/utilisation.md): How billable time percentage is calculated and tracked in CharleOS
- [Better Auth Configuration](https://docs.charle.agency/developer/auth/better-auth.md): How CharleOS uses Better Auth for authentication
- [Authentication](https://docs.charle.agency/developer/auth/index.md): How authentication and authorization work in CharleOS
- [Permissions](https://docs.charle.agency/developer/auth/permissions.md): Role-based access control in CharleOS
- [Sessions](https://docs.charle.agency/developer/auth/sessions.md): Session lifecycle and management in CharleOS
- [Drizzle ORM](https://docs.charle.agency/developer/database/drizzle.md): Query builder syntax and patterns for CharleOS
- [Database](https://docs.charle.agency/developer/database/index.md): Working with PostgreSQL and Drizzle ORM in CharleOS
- [Migrations](https://docs.charle.agency/developer/database/migrations.md): Managing database schema changes in CharleOS
- [Database Schema](https://docs.charle.agency/developer/database/schema.md): Complete reference for all tables and relationships in CharleOS
- [CI/CD Pipeline](https://docs.charle.agency/developer/deployment/ci-cd.md): Automated testing and deployment workflow
- [Deployment](https://docs.charle.agency/developer/deployment/index.md): Deploying CharleOS to production
- [Vercel Deployment](https://docs.charle.agency/developer/deployment/vercel.md): Vercel-specific configuration and features
- [Environment Variables](https://docs.charle.agency/developer/getting-started/environment.md): Complete reference for CharleOS configuration
- [Overview](https://docs.charle.agency/developer/getting-started/index.md): Getting started with CharleOS development
- [Local Setup](https://docs.charle.agency/developer/getting-started/local-setup.md): Get CharleOS running on your local machine
- [Project Structure](https://docs.charle.agency/developer/getting-started/project-structure.md): Understanding the CharleOS codebase organization
- [E2E Tests](https://docs.charle.agency/developer/testing/e2e-tests.md): End-to-end testing with Cypress in CharleOS
- [Testing](https://docs.charle.agency/developer/testing/index.md): Testing strategy and tools in CharleOS
- [Unit Tests](https://docs.charle.agency/developer/testing/unit-tests.md): Writing unit tests with Vitest in CharleOS
- [Overview](https://docs.charle.agency/user-guide/alan/index.md): Meet Alan, your AI assistant for CharleOS
- [Scheduling with Alan](https://docs.charle.agency/user-guide/alan/scheduling.md): Use Alan to get intelligent assignment recommendations
- [What You Can Ask](https://docs.charle.agency/user-guide/alan/what-you-can-ask.md): Example queries and questions Alan can answer
- [Annual Leave](https://docs.charle.agency/user-guide/annual-leave/index.md): Managing time off and leave requests
- [Leave Calendar](https://docs.charle.agency/user-guide/annual-leave/leave-calendar.md): Viewing and managing your leave calendar
- [Requesting Leave](https://docs.charle.agency/user-guide/annual-leave/requesting-leave.md): How to submit and manage leave requests
- [Block Types](https://docs.charle.agency/user-guide/blocks/block-types.md): Understanding different block types and when to use them
- [Hours Tracking](https://docs.charle.agency/user-guide/blocks/hours-tracking.md): How block hours are tracked and displayed
- [Blocks](https://docs.charle.agency/user-guide/blocks/index.md): Capacity reservations for client work
- [Scheduling Blocks](https://docs.charle.agency/user-guide/blocks/scheduling-blocks.md): Configuring, assigning, and managing blocks
- [Client Intelligence](https://docs.charle.agency/user-guide/clients/client-intelligence.md): Understanding client deliverability scores and how they improve scheduling accuracy
- [Client Schedule](https://docs.charle.agency/user-guide/clients/client-schedule.md): Plan and schedule work for specific clients
- [Overview](https://docs.charle.agency/user-guide/clients/index.md): Manage client relationships, retainers, and schedules in CharleOS
- [Client Profiles](https://docs.charle.agency/user-guide/clients/profiles.md): View and manage client information in CharleOS
- [Retainer Plans](https://docs.charle.agency/user-guide/clients/retainer-plans.md): Understanding retainer plans, hours allocation, and pricing
- [First Login](https://docs.charle.agency/user-guide/getting-started/first-login.md): Set up your CharleOS account and get started
- [Introduction](https://docs.charle.agency/user-guide/getting-started/index.md): Welcome to CharleOS - the agency management platform for Charle
- [Navigation](https://docs.charle.agency/user-guide/getting-started/navigation.md): Learn how to navigate CharleOS and find features quickly
- [Creating Tickets](https://docs.charle.agency/user-guide/help-desk/creating-tickets.md): How to submit help desk tickets
- [Help Desk](https://docs.charle.agency/user-guide/help-desk/index.md): Managing client support tickets and internal escalations
- [Resolving Tickets](https://docs.charle.agency/user-guide/help-desk/resolving-tickets.md): How to close and resolve help desk tickets
- [Ticket Types](https://docs.charle.agency/user-guide/help-desk/ticket-types.md): Understanding support, escalation, and question tickets
- [Ticket Workflow](https://docs.charle.agency/user-guide/help-desk/ticket-workflow.md): How tickets progress through statuses
- [Projects](https://docs.charle.agency/user-guide/projects/index.md): Managing fixed-scope project work
- [Progress & Budgets](https://docs.charle.agency/user-guide/projects/progress-budgets.md): Tracking project progress and budget vs actual
- [Project Phases](https://docs.charle.agency/user-guide/projects/project-phases.md): Organizing project work into phases
- [Project Tasks](https://docs.charle.agency/user-guide/projects/project-tasks.md): Managing tasks within project phases
- [AI Suggestions](https://docs.charle.agency/user-guide/quotes/ai-suggestions.md): How Alan suggests t-shirt sizes and time estimates for quotes
- [Approval Workflow](https://docs.charle.agency/user-guide/quotes/approval-workflow.md): Understanding quote approval and client review
- [Converting to Tasks](https://docs.charle.agency/user-guide/quotes/converting-to-tasks.md): How approved quotes become tasks
- [Creating Quotes](https://docs.charle.agency/user-guide/quotes/creating-quotes.md): How to create and edit quotes in CharleOS
- [Overview](https://docs.charle.agency/user-guide/quotes/index.md): Understanding quotes and work estimation in CharleOS
- [Requirement Blocks](https://docs.charle.agency/user-guide/quotes/requirement-blocks.md): Building and estimating quote requirements
- [Client History](https://docs.charle.agency/user-guide/rag/client-history.md): Viewing RAG status trends for individual clients
- [RAG Reporting](https://docs.charle.agency/user-guide/rag/index.md): Client health monitoring and status reporting
- [Recording Reports](https://docs.charle.agency/user-guide/rag/recording-reports.md): Step-by-step guide to completing weekly RAG reports
- [Day Breakdown](https://docs.charle.agency/user-guide/schedule/day-breakdown.md): Viewing and managing daily task lists and capacity
- [Overview](https://docs.charle.agency/user-guide/schedule/index.md): Managing work schedules and team capacity in CharleOS
- [Priority System](https://docs.charle.agency/user-guide/schedule/priority-system.md): How scheduling priorities work and how to adjust them
- [Timeline View](https://docs.charle.agency/user-guide/schedule/timeline-view.md): Navigating the schedule timeline and calendar view
- [Overview](https://docs.charle.agency/user-guide/tasks/index.md): Managing tasks and delivery work in CharleOS
- [Reviews & Sign-offs](https://docs.charle.agency/user-guide/tasks/reviews-signoffs.md): Understanding the review and approval process
- [Running Behind](https://docs.charle.agency/user-guide/tasks/running-behind.md): What to do when a subtask needs more time than estimated
- [Subtasks](https://docs.charle.agency/user-guide/tasks/subtasks.md): Working with subtasks and managing delivery work
- [Task Phases](https://docs.charle.agency/user-guide/tasks/task-phases.md): Understanding task workflow phases and transitions
- [Activity Types](https://docs.charle.agency/user-guide/time-tracking/activity-types.md): When to use each activity type for time tracking
- [Overview](https://docs.charle.agency/user-guide/time-tracking/index.md): Track time against tasks, tickets, and activities in CharleOS
- [Logging Time](https://docs.charle.agency/user-guide/time-tracking/logging-time.md): Step-by-step guide to logging time entries in CharleOS

## OpenAPI Specs

- [openapi](https://docs.charle.agency/api-reference/openapi.json)