Imported from rafaeltab/darlingai (
AGENTS.md). Install upstream withnpx skills add rafaeltab/darlingai. Copyright stays with the author.
Darling AI Agent
Project Goal
Darling AI is a cross-platform AI personal assistant designed to provide personalized, voice-enabled assistance with advanced features including voice recognition, custom TTS, task management, and flexible skill-based specialization. The goal is to create an intelligent assistant that can differentiate between users, maintain conversation continuity, integrate with various systems, and be both user-friendly and programmable through a configurable DSL interface.
Documentation Guidelines
Important: When creating or updating documentation (especially markdown files that will be rendered in Next.js with Fumadocs), do NOT put links inside markdown headers. This causes hydration errors. Instead, add a paragraph after the header and place links there.
Incorrect:
## [My Section](https://example.com)
Correct:
## My Section
For more information, see the [documentation](https://example.com).
Documentation
The project includes comprehensive documentation located in apps/docs/content/docs/ which contains:
- Project documentation and guides
- API references
- Implementation details
Architecture Documentation
The architecture documentation is located in apps/docs/content/docs/architecture/ and provides comprehensive guidance on:
- Architecture Overview (
architecture/index.mdx) - High-level architecture direction and organization - Infrastructure (
architecture/infrastructure.mdx) - Kubernetes, Docker, hosting, and infrastructure decisions - Project Structure (
architecture/project-structure.mdx) - Repository organization and code structure - Technology Stack (
architecture/technology-stack.mdx) - Framework and technology choices - Application Architecture (
architecture/application-architecture.mdx) - DDD, hexagonal architecture, EDA patterns - Telemetry (
architecture/telemetry.mdx) - Observability, monitoring, and logging - CI/CD (
architecture/ci-cd.mdx) - Continuous integration and delivery pipelines - Testing (
architecture/testing.mdx) - Unit, integration, E2E, and performance testing strategies
When implementing features or making architectural decisions, consult these documents first. If decisions need to be made to fill in placeholder sections, update the relevant architecture document with the decision and rationale.
Decision Records
When working on this project, the agent should document important decisions in the apps/docs/content/docs/decision-records/ folder. This includes:
- Architectural decisions and rationale
- Major changes to project structure or tooling
- Technology choices and trade-offs
- Design patterns and conventions adopted
- Breaking changes and migration strategies
Each decision record should be clearly dated and provide context for future reference.
The project has adopted Option 2: Microservices Architecture as documented in decision-records/architecture-initial/option-2-microservices.mdx.