Skip to content

Add CLAUDE.md guide for AI assistants working with the repository#364

Open
amjad2161 wants to merge 1 commit into
anthropics:mainfrom
amjad2161:claude/claude-md-mm3sqts19hj5o89l-OYuGW
Open

Add CLAUDE.md guide for AI assistants working with the repository#364
amjad2161 wants to merge 1 commit into
anthropics:mainfrom
amjad2161:claude/claude-md-mm3sqts19hj5o89l-OYuGW

Conversation

@amjad2161
Copy link
Copy Markdown

@amjad2161 amjad2161 commented Feb 26, 2026

Description

Added a comprehensive CLAUDE.md file to provide guidance for AI assistants (Claude Code and similar tools) working with this monorepo. This document serves as a reference guide for understanding the structure, setup, and conventions across all three quickstart projects.

The guide includes:

  • Repository overview — Explains the monorepo structure and that projects are independent
  • Project 1: customer-support-agent — Next.js 14 customer support chatbot with RAG, including directory layout, key files, environment variables, npm scripts, and API response schema
  • Project 2: financial-data-analyst — Next.js 14 financial data analyst with file uploads and charting, including supported file types and chart types
  • Project 3: computer-use-demo — Python/Streamlit computer use agent with Docker support, including setup instructions, testing, linting, and provider configuration
  • Common conventions — Shared patterns across TypeScript projects (cn() utility, shadcn/ui, App Router, TypeScript patterns, styling)
  • CI/CD — GitHub Actions workflows and pre-commit hooks
  • Important notes for AI assistants — Critical gotchas like AWS credential naming, Python version requirements, Rust dependency, edge runtime constraints, and beta API usage

Quickstart

  • N/A

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Code refactoring
  • Other (please describe):

Testing

No testing needed — this is a documentation-only change.

Additional Notes

This file is intended to be read by AI assistants (like Claude Code) to understand the repository structure and conventions before making changes. It consolidates information that would otherwise be scattered across multiple README files and configuration files.

https://claude.ai/code/session_01PSnxWsjUSUdv9xDTqDb4od

Documents the full codebase structure, development workflows, and key
conventions for all three quickstart projects: customer-support-agent
(Next.js/RAG), financial-data-analyst (Next.js/charting), and
computer-use-demo (Python/Streamlit/Docker).

https://claude.ai/code/session_01PSnxWsjUSUdv9xDTqDb4od
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants