Skip to content

docs: enhance CLAUDE.md with comprehensive development guidance#1

Draft
cssjr wants to merge 3 commits into
mainfrom
docs/update-claude-md
Draft

docs: enhance CLAUDE.md with comprehensive development guidance#1
cssjr wants to merge 3 commits into
mainfrom
docs/update-claude-md

Conversation

@cssjr

@cssjr cssjr commented May 11, 2026

Copy link
Copy Markdown
Owner

Summary

This PR significantly expands CLAUDE.md to provide comprehensive guidance for Claude Code when working in this repository.

Changes

  • Added detailed prerequisites and tool installation instructions
  • Documented VSCode Remote Containers setup with macOS-specific guidance
  • Expanded architecture details including request flow and cluster types
  • Added development workflows for Frontend, Backend, Admin API, and Sessiongate
  • Documented common development commands for building, testing, and deployment
  • Added E2E testing framework architecture and best practices
  • Included personal dev environment setup procedures
  • Documented Go workspace management and configuration materialization
  • Added important development notes (lint tags, nil checks in tests, etc.)

Key Sections Added

  • Target Environments and Access Patterns
  • Service Cluster vs Management Cluster architecture
  • Infrastructure Scopes (Global, Geography, Regional)
  • Personal Dev Environment workflows
  • E2E Testing with custom test runner
  • Image bump procedures
  • Production deployment workflow

This provides Claude Code with the multi-file architectural understanding needed to be productive in this codebase without duplicating content easily discoverable in individual component READMEs.

cssjr and others added 3 commits May 11, 2026 10:10
- Add proper file header for Claude Code
- Fix typo in Project Overview
- Add Architecture Details section with request flow and cluster types
- Document infrastructure scopes (global, geography, regional)
- Add comprehensive Common Development Commands section
- Document E2E testing framework and best practices
- Add Important Development Notes for critical patterns
- Include references to operational documentation
- Add Prerequisites section with required tools and authentication
- Add VSCode Remote Containers setup guide with macOS colima instructions
- Fix EKS → AKS typo in Deployments section
- Clarify personal-dev-env vs local-pers-dev-env distinction
- Add Configuration Materialization section for templatize system
- Document make materialize and verify-materialize commands
- Added Admin API and Sessiongate component descriptions
- Added Admin API development workflow section
- Updated Service Cluster components list
- Added architecture diagram reference
- Updated Go workspace modules list

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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.

1 participant