Skip to content

CLAUDE.md

Latest commit

 

History

History
80 lines (58 loc) · 3.7 KB

CLAUDE.md

File metadata and controls

80 lines (58 loc) · 3.7 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Role & Responsibilities

Your role is to analyze user requirements, delegate tasks to appropriate sub-agents, and ensure cohesive delivery of features that meet specifications and architectural standards.

Workflows

  • Primary workflow: ./.claude/workflows/primary-workflow.md
  • Development rules: ./.claude/workflows/development-rules.md
  • Orchestration protocols: ./.claude/workflows/orchestration-protocol.md
  • Documentation management: ./.claude/workflows/documentation-management.md
  • And other workflows: ./.claude/workflows/*

IMPORTANT: Analyze the skills catalog and activate the skills that are needed for the task during the process. IMPORTANT: You must follow strictly the development rules in ./.claude/workflows/development-rules.md file. IMPORTANT: Before you plan or proceed any implementation, always read the ./README.md file first to get context. IMPORTANT: Sacrifice grammar for the sake of concision when writing reports. IMPORTANT: In reports, list any unresolved questions at the end, if any.

Python Scripts (Skills)

When running Python scripts from .claude/skills/, use the venv Python interpreter:

  • Linux/macOS: .claude/skills/.venv/bin/python3 scripts/xxx.py
  • Windows: .claude\skills\.venv\Scripts\python.exe scripts\xxx.py

This ensures packages installed by install.sh (google-genai, pypdf, etc.) are available.

UI/Styling Conventions

  • Code snippet boxes: Always support both light and dark mode
    • Background: bg-slate-100 dark:bg-slate-800/90
    • Text: text-slate-700 dark:text-slate-200
    • Command highlights: text-purple-600 dark:text-purple-400
    • Secondary text: text-slate-500 dark:text-slate-400

VividKit Guides - Changelog Sync

When running /vk:changelog-sync, update these locations:

CommandsGuide (src/components/guides/commands/)

  1. Version badges: commands-categories-grid.astro - EK/MK version labels
  2. Beta Preview section: commands-categories-grid.astro lines ~99-122 - NEW/ENHANCED/DEPRECATED skills
  3. Commands data: src/data/guides/commands-engineer-kit.ts, commands-marketing-kit.ts
  4. i18n strings: src/i18n/en/commands.ts, src/i18n/vi/commands.ts

Other Guides

  • Flowchart versions: flowchart-marketing-v12-data.ts, flowchart-marketing-summary-section.astro
  • Hooks data: src/data/guides/custom-hooks/custom-hooks-data.ts
  • Workflows data: src/data/guides/workflows-data/workflows-stable.ts, workflows-beta-additions.ts

Workflows - Bilingual Files

When adding new workflow cards, update BOTH:

  • EN: src/data/guides/workflows-data/workflows-*.ts
  • VI: src/data/vi/guides/workflows-data/workflows-*.ts

IMPORTANT: Beta Preview section is separate from main commands grid - don't forget to update both!

HTML in Detail Fields

  • Stable commands (commands-engineer-kit.ts): Uses {cmd.detail} → NO HTML rendering → don't use <br/>
  • Beta Preview (commands-categories-grid.astro): Uses set:html → renders HTML → can use <br/>

Documentation Management

We keep all important docs in ./docs folder and keep updating them, structure like below:

./docs
├── project-overview-pdr.md
├── code-standards.md
├── codebase-summary.md
├── design-guidelines.md
├── deployment-guide.md
├── system-architecture.md
└── project-roadmap.md

IMPORTANT: MUST READ and MUST COMPLY all INSTRUCTIONS in project ./CLAUDE.md, especially WORKFLOWS section is CRITICALLY IMPORTANT, this rule is MANDATORY. NON-NEGOTIABLE. NO EXCEPTIONS. MUST REMEMBER AT ALL TIMES!!!