Skip to content

ZENCODER.md

Latest commit

 

History

History
101 lines (73 loc) · 3.44 KB

ZENCODER.md

File metadata and controls

101 lines (73 loc) · 3.44 KB
Raw

ZENCODER.md — Ever Teams Instructions for Zencoder

This repository uses .zencoder/ as the primary configuration directory for Zencoder AI.

All comprehensive project instructions, coding standards, and repository information are organized in modular files within .zencoder/ for better maintainability and organization.

Configuration Files

.zencoder/README.md

Overview of the Zencoder configuration structure, maintenance guidelines, and how to use the documentation.

.zencoder/rules/repo.md (Auto-Generated)

Repository structure documentation including:

  • All applications (web, mobile, desktop, extension, playground)
  • All shared packages with build systems
  • Docker configurations
  • Testing frameworks
  • Architectural organization

Note: This file is auto-generated by repository analysis. Regenerate periodically when structure changes.

.zencoder/rules/workspace.md (Comprehensive Guide)

Complete workspace rules and project instructions including:

  • Project overview and architecture
  • Runtime requirements and environment setup
  • All common commands (dev, build, lint, test)
  • Detailed code organization and structure
  • Tech stack reference with versions
  • Verification and testing strategy
  • Safety guidelines and permissions
  • Commit conventions
  • Internationalization rules
  • Zencoder workflow
  • Key patterns to follow
  • Documentation resources

This is the main comprehensive reference for day-to-day development.

.zencoder/rules/coding-standards.md

Detailed coding standards and best practices covering:

  • TypeScript standards and patterns
  • React component patterns
  • State management (Jotai, TanStack Query)
  • API and service layer architecture
  • Form handling with React Hook Form + Zod
  • Styling with Tailwind CSS
  • Error handling patterns
  • Performance optimization techniques
  • Security best practices
  • Testing patterns
  • File naming conventions

Quick Start

When starting work on this repository, Zencoder should:

  1. Read .zencoder/README.md for configuration overview
  2. Reference .zencoder/rules/workspace.md for comprehensive project instructions
  3. Consult .zencoder/rules/repo.md for repository structure and commands
  4. Follow .zencoder/rules/coding-standards.md when implementing features

Related AI Configurations

This repository includes configurations for multiple AI coding assistants:

  • CLAUDE.md - Claude Code specific instructions
  • AGENTS.md - Cursor agent instructions with Nx MCP
  • AUGMENT.md - Augment Code meta-instructions
  • .augment/rules/workspace.md - Augment-specific rules

See .zencoder/AI-CONFIG-COMPARISON.md for detailed comparison and relationship between these configurations.

Why Modular Organization?

The .zencoder/ directory structure provides:

✅ Modular organization - Separate concerns into focused files
✅ Auto-generated documentation - Repository structure stays up-to-date
✅ Comprehensive standards - Detailed coding patterns and best practices
✅ Easy maintenance - Update specific sections without affecting others
✅ Clear hierarchy - Logical organization of information

Documentation

For all detailed instructions, see .zencoder/ directory.