Where to Find DeskcommCRM Architecture and Doctrine Documentation

DeskcommCRM maintains its architectural blueprint and governing doctrine in five markdown files at the repository root—ARCHITECTURE.md, CLAUDE.md, VISION.md, AGENTS.md, and SECURITY.md—which collectively define the system's design principles, coding standards, and security posture.

DeskcommCRM is an open-source CRM platform built on Next.js 16, Supabase, and integrated services including WAHA, Redis, and AI gateways. To fully understand DeskcommCRM's architecture and doctrine, developers must reference the authoritative documentation files stored in the melgarafael/DeskcommCRM repository root, as these files contain the specifications for system components, development constraints, and long-term strategic goals that drive the platform.

Core Documentation Files

The repository organizes its knowledge base into discrete markdown files, each addressing a specific aspect of the system's architecture or governance.

ARCHITECTURE.md: System Components and Design

The ARCHITECTURE.md file provides the top-down architectural overview of the DeskcommCRM platform. According to the source code repository, this document describes the platform's core components—the Next.js 16 application layer, Supabase backend, WAHA integration, Redis caching layer, and AI gateway services—and details the critical separation between platform-wide services and tenant-scoped resources. It further delineates the responsibilities of each architectural layer, making it the primary reference for understanding how the system processes data and manages multi-tenancy.

CLAUDE.md: Development Doctrine and Governance

The CLAUDE.md file contains the non-negotiable development doctrine that all contributors must follow. As implemented in melgarafael/DeskcommCRM, this file establishes the project's coding standards, versioning policy, security constraints, database migration conventions, and QA requirements. It serves as the canonical source for the disciplined approach that guides the platform's evolution, ensuring consistency across contributions.

VISION.md: Strategic Context and Roadmap

The VISION.md file provides the strategic foundation for architectural decisions found in ARCHITECTURE.md. This document outlines the product's purpose, market positioning, and long-term roadmap, giving developers context for why specific technical choices—such as the adoption of particular AI services or data isolation strategies—were made.

AGENTS.md: AI Agent Specifications

The AGENTS.md file details the platform's native AI agents, their interaction models, and required interfaces. This documentation is essential for understanding how DeskcommCRM integrates artificial intelligence into its workflow automation, specifying the contracts that AI services must fulfill to operate within the architecture.

SECURITY.md: Threat Model and Hardening

The SECURITY.md file enumerates the platform's security posture, threat model, and hardening measures. This documentation is integral to the architecture, describing the security constraints that protect tenant data and platform-wide resources across all layers of the stack.

Reading Documentation Programmatically

Developers can access these architectural documents at runtime for tooling, validation, or documentation generation purposes. The following examples demonstrate how to load the architecture file within the DeskcommCRM environment while respecting repository paths and security constraints.

To read the ARCHITECTURE.md file in a Node.js environment:

// Example: Load the architecture markdown at runtime (Node.js)
import { readFile } from 'fs/promises';
import path from 'path';

const archPath = path.resolve(process.cwd(), 'ARCHITECTURE.md');

async function getArchitecture(): Promise<string> {
  const content = await readFile(archPath, 'utf-8');
  return content;
}

// Usage
getArchitecture()
  .then(md => console.log('Architecture snapshot:\n', md.slice(0, 300)))
  .catch(err => console.error('Failed to read ARCHITECTURE.md:', err));

To render a link to the architecture documentation within a Next.js component:

// Example: Render a link to the architecture doc in a Next.js component
import Link from 'next/link';

export default function ArchitectureLink() {
  return (
    <p>
      For a complete view of the system, see the{' '}
      <Link href="/ARCHITECTURE.md">
        <a>Architecture documentation</a>
      </Link>.
    </p>
  );
}

Summary

• ARCHITECTURE.md contains the high-level system diagram and component responsibilities for the Next.js 16, Supabase, and integrated service stack.
• CLAUDE.md defines the coding standards, versioning policy, and non-negotiable development doctrine governing all contributions.
• VISION.md provides the strategic context and product roadmap that inform architectural decisions.
• AGENTS.md specifies the AI agent interfaces and integration requirements within the platform.
• SECURITY.md documents the threat model, security requirements, and hardening guidelines essential to the architecture.
• The README.md serves as the entry point, linking to these authoritative sources for complete system understanding.

Frequently Asked Questions

What is the primary file for DeskcommCRM architecture documentation?

The primary file is ARCHITECTURE.md located at the repository root. This file contains the definitive technical description of the platform's components, including the Next.js 16 application structure, Supabase backend services, WAHA integration, Redis caching, and AI gateway configurations, along with the separation between platform-wide and tenant-scoped resources.

Where are the coding standards and development rules defined in DeskcommCRM?

All coding standards, versioning policies, security constraints, and QA requirements are defined in CLAUDE.md. This file serves as the project's doctrine, establishing the non-negotiable rules that every contributor must follow when developing or deploying features within the DeskcommCRM ecosystem.

How does DeskcommCRM document its AI agent architecture?

AI agent specifications are detailed in AGENTS.md. This document outlines the role of native AI agents within the system, their specific interaction models, and the required interfaces for integration, providing developers with the technical contracts necessary to extend or modify agent functionality.

Which file contains the security doctrine and threat model for DeskcommCRM?

The security documentation, including the threat model and hardening measures, is contained in SECURITY.md. This file describes the security posture integral to the architecture, detailing how the platform protects against vulnerabilities and ensuring that security considerations are embedded across all layers of the Next.js and Supabase infrastructure.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}