Skip to content

Add CLAUDE.md project documentation and guidelines#81

Open
EagleEyeVisionLabz wants to merge 1 commit intoTechHutTV:mainfrom
EagleEyeVisionLabz:claude/claude-md-mmd74mieepj4nznv-9Hrn0
Open

Add CLAUDE.md project documentation and guidelines#81
EagleEyeVisionLabz wants to merge 1 commit intoTechHutTV:mainfrom
EagleEyeVisionLabz:claude/claude-md-mmd74mieepj4nznv-9Hrn0

Conversation

@EagleEyeVisionLabz
Copy link

Summary

Added comprehensive project documentation file (CLAUDE.md) that serves as a reference guide for understanding the homelab repository structure, conventions, and operational patterns.

Key Changes

  • Project Overview: Documented the homelab as a self-hosted infrastructure repository running on Proxmox VE with Docker Compose stacks
  • Repository Structure: Added visual directory tree showing all major functional areas (apps, cloud, homeassistant, media, monitoring, proxy, storage, surveillance)
  • Technology Stack: Created reference table covering hypervisor, container runtime, storage, media services, downloads, smart home, monitoring, networking, surveillance, and cloud solutions
  • File Conventions: Documented standards for Docker Compose files, environment variables, network patterns, and markdown documentation
  • Important Patterns: Listed critical guidelines including secret management, naming conventions, directory isolation, and documentation pairing
  • Common Operations: Provided quick reference for frequently used Docker Compose commands
  • External Dependencies: Listed third-party services and hardware integrations (Cloudflare, AirVPN, Twingate, Google Coral TPU, Intel GPU)

Implementation Details

This documentation file establishes a single source of truth for contributors and maintainers regarding:

  • How the repository is organized and why
  • Naming and structural conventions to maintain consistency
  • Security practices (never committing secrets)
  • Hardware passthrough and device mapping patterns
  • Integration points with external services and APIs

The document is structured to be both a quick reference guide and a comprehensive onboarding resource for understanding the complete homelab infrastructure.

https://claude.ai/code/session_01VcmYdJyRsuVYznCU1dkPMV

Documents repository structure, technologies, file conventions, network
patterns, and common operations to help AI assistants understand and
work with the homelab infrastructure configs.

https://claude.ai/code/session_01VcmYdJyRsuVYznCU1dkPMV
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