brianhansonxyz/rspade_system
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix CLAUDE.dist.md header to use ASCII characters only

Browse Source 
Fix CLAUDE.md placement: move to rspade_project repository

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
root
2025-10-21 04:08:22 +00:00
parent 438623a729
commit ae38320d9e
2 changed files with 9 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
CLAUDE.md
View File

@@ -1,43 +0,0 @@
# 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]

18
docs/CLAUDE.dist.md
View File

@@ -1,7 +1,7 @@
<!--
═══════════════════════════════════════════════════════════════════════════
⚠️ READ-ONLY FRAMEWORK DOCUMENTATION
═══════════════════════════════════════════════════════════════════════════
===============================================================================
WARNING: READ-ONLY FRAMEWORK DOCUMENTATION
===============================================================================
This file contains RSpade framework documentation for AI/LLM assistants and is
maintained by the framework developers. It is marked read-only and will be
@@ -11,15 +11,15 @@ DO NOT modify this file directly. Any changes you make will be lost during the
next framework update.
For application-specific documentation and project context:
→ Edit the CLAUDE.md file in your project root
→ That file is NOT managed by the framework and persists across updates
- Edit the CLAUDE.md file in your project root
- That file is NOT managed by the framework and persists across updates
This separation ensures:
• Framework documentation stays current with updates
• Your project-specific documentation is preserved
• AI assistants have access to both framework and application context
- Framework documentation stays current with updates
- Your project-specific documentation is preserved
- AI assistants have access to both framework and application context
═══════════════════════════════════════════════════════════════════════════
===============================================================================
-->
# RSpade Framework - AI/LLM Development Guide