---

source: .cursorrules type: cursorrules

Project Rules and Guidelines

Auto-generated from .context/docs on 2026-02-23T20:51:48.350Z

README

Documentation Overview

Welcome to the documentation directory of the Resume Figma project. This README serves as an entry point and index to the comprehensive guides and resources available within the docs/ folder to help developers, contributors, and stakeholders understand and effectively work with the repository.

Contents of the docs/ Directory

The docs/ folder contains in-depth markdown files covering all major aspects of the project, including architecture, development workflows, testing, domain concepts, and more. These guides are designed to provide clarity on the repository layout, coding conventions, and operational practices.

Core Guides

• Project Overview
  Introduction to the project’s purpose, goals, and high-level roadmap. It outlines the key features and stakeholders involved.

• Architecture Notes
  Details the structural design, component organization, technology stack, and architectural rationale. Includes diagrams and explanations of major modules and their responsibilities.

• Development Workflow
  Explains the branching strategy, commit conventions, CI/CD processes, and coding standards to streamline contributions and maintain code quality.

• Testing Strategy
  Describes testing frameworks, coverage targets, types of tests (unit, integration, end-to-end), and guidelines for writing effective tests.

• Glossary & Domain Concepts
  Defines key business terms, user personas, domain models, and concepts relevant to the application domain.

• Data Flow & Integrations
  Illustrates data pipelines, external integrations, APIs, and event-driven interactions that the system relies on or exposes.

• Security & Compliance Notes
  Covers authentication and authorization models, data privacy controls, secrets management, and compliance with relevant standards.

• Tooling & Productivity Guide
  Provides information on development tools, IDE configurations, scripts, and automation to boost developer productivity.

Repository Snapshot

The project repository contains the following top-level files and directories:

• Source and UI components (e.g., components/, resume/components/)
• Entry points and configuration files (main.tsx, package.json, vite.config.ts)
• TypeScript configurations (tsconfig.json, etc.)
• Additional documentation and changelogs (CHANGELOG.md, README.md)
• Scripts and styles folders for auxiliary resources

How to Use This Documentation

• Start by reading the Project Overview to gain a broad understanding of the repository’s intent and scope.
• Consult the Architecture Notes for insight into the design and key patterns, especially if you plan to extend or refactor the codebase.
• Follow the Development Workflow guide for contribution guidelines and to understand the CI/CD pipeline.
• Leverage the Testing Strategy when writing or maintaining tests to ensure quality and reliability.
• Reference the Glossary to familiarize yourself with domain-specific terminology.
• Review the Data Flow & Integrations and Security & Compliance guides for operational and security-related considerations.
• Use the Tooling & Productivity Guide to streamline your local setup and development tasks.

Cross-References

• Many UI components follow consistent conventions documented in the architecture and can be found under components/ui and resume/components/ui.
• Utility functions, hooks (e.g., useIsMobile), and shared types like ChartConfig are defined in these UI directories and adhere to patterns described in the architectural guides.
• The modular component design supports flexible resume-building features, integrated with Figma-based UI elements located in components/figma and resume/components/figma.

---

For any further questions or contributions, please refer to the contribution guidelines in the development-workflow.md and consult your team lead or project maintainer.

Happy coding!