Files
rspade_system/CLAUDE.md
root 438623a729 Add CLAUDE.md management for published repositories
Update publish script to create .env.dist at project root

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-21 04:03:03 +00:00

1.7 KiB

Project-Specific Documentation

PURPOSE: This file is for your application-specific documentation, development notes, and project context that AI/LLM assistants should be aware of when working on your codebase.

Framework Documentation Location

RSpade framework documentation for AI/LLM assistants is located at:

  • ~/.claude/CLAUDE.md - Framework documentation (updated with php artisan rsx:framework:pull)
  • ./docs/CLAUDE.dist.md - Same content, read-only, replaced during framework updates

DO NOT modify ./docs/CLAUDE.dist.md - it will be replaced during framework updates.

This File (CLAUDE.md)

Use this file to document:

  • Project-specific context - Business domain, purpose, architectural decisions
  • Custom conventions - Team-specific patterns, naming conventions, coding standards
  • Development notes - Setup instructions, deployment procedures, known issues
  • Module documentation - Descriptions of your custom modules and their purposes
  • API integrations - Third-party services, authentication details, endpoints
  • Database schema notes - Important relationships, migration strategies, data models

This file is NOT managed by the framework and will persist across framework updates.


Example Documentation Structure

Project Overview

[Describe what this application does and who it's for]

Architecture Decisions

[Document key architectural choices and why they were made]

Custom Modules

[List and describe your RSX modules in /rsx/app/]

Development Workflow

[Team-specific practices, git workflow, deployment process]

Environment Setup

[Project-specific setup requirements beyond standard RSpade installation]