f6fac6c4bc
Fix bin/publish: use correct .env path for rspade_system Fix bin/publish script: prevent grep exit code 1 from terminating script 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
59 lines
2.4 KiB
Markdown
Executable File
59 lines
2.4 KiB
Markdown
Executable File
# RSpade Framework Documentation
|
|
|
|
## For Developers Using RSpade
|
|
|
|
Welcome to the RSpade framework documentation. RSpade is a Visual Basic-like development environment for PHP/Laravel that prioritizes simplicity, straightforwardness, and rapid development.
|
|
|
|
### Getting Started
|
|
|
|
1. **LLM Integration**: Point your AI assistant to `CLAUDE.dist.md` for comprehensive development directives
|
|
2. **Architecture**: Read `rsx-architecture.md` for framework overview and core concepts
|
|
3. **Coding Standards**: See `coding-conventions.md` for naming conventions and style guide
|
|
4. **Framework Updates**: Follow `framework_upstream.md` to sync with upstream framework updates
|
|
|
|
### Documentation Files
|
|
|
|
#### Core Documentation
|
|
- **`CLAUDE.dist.md`** - Comprehensive AI/LLM development guide (primary reference)
|
|
- **`rsx-architecture.md`** - Architecture overview and core philosophy
|
|
- **`rsx-dispatch-system.md`** - Routing and request handling system
|
|
- **`coding-conventions.md`** - Code style, naming standards, and conventions
|
|
|
|
#### Framework Behavior
|
|
- **`framework_divergences.md`** - How RSpade differs from standard Laravel
|
|
- **`framework_upstream.md`** - Keeping your project updated with framework changes
|
|
|
|
#### Advanced Topics
|
|
- **`llm_migration_system.md`** - Snapshot-based migration system for AI-friendly development
|
|
|
|
#### External Libraries
|
|
- **`jqhtml_quickstart.md`** - JQHTML component system build process
|
|
- **`jqhtml_migration_report.md`** - JQHTML NPM package migration notes
|
|
- **`jqhtml_vscode_extension_setup.md`** - VS Code extension setup for JQHTML
|
|
|
|
### Quick Reference
|
|
|
|
**Common Commands:**
|
|
```bash
|
|
php artisan rsx:check # Check code quality
|
|
php artisan rsx:clean # Clear caches (troubleshooting)
|
|
php artisan rsx:debug /route # Test routes with headless browser
|
|
php artisan rsx:man <topic> # View detailed documentation
|
|
```
|
|
|
|
**Project Structure:**
|
|
```
|
|
/rsx/ # Your application code (RSX)
|
|
├── app/ # Application modules
|
|
├── models/ # Database models
|
|
├── theme/ # Global theme assets
|
|
├── main.php # App-wide middleware
|
|
└── permission.php # Authorization methods
|
|
|
|
/app/RSpade/ # Framework runtime (do not modify)
|
|
```
|
|
|
|
### Support
|
|
|
|
For issues or questions about the RSpade framework, refer to the comprehensive `CLAUDE.dist.md` documentation or consult the specific topic files listed above.
|