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>
65 lines
2.0 KiB
Markdown
Executable File
65 lines
2.0 KiB
Markdown
Executable File
# RSX Framework Manual Pages
|
|
|
|
## Overview
|
|
|
|
This directory contains technical documentation for the RSX Framework, formatted as traditional Unix manual pages from the late 1990s. Plain text format ensures easy copying and pasting of examples.
|
|
|
|
## Design Philosophy
|
|
|
|
- **Plain text format** - No fancy formatting or special characters
|
|
- **Laravel comparisons** - Explicit differences from Laravel equivalents
|
|
- **Framework philosophy** - Explains the "why" behind RSX design choices
|
|
- **Practical examples** - Real-world usage patterns
|
|
- **LLM-optimized** - Structured for easy parsing
|
|
|
|
## Available Documentation
|
|
|
|
### Core Systems
|
|
|
|
- `manifest_api.txt` - Manifest class API for file discovery and metadata
|
|
- `manifest_build.txt` - Manifest compilation process and extension system
|
|
- `bundle_api.txt` - Bundle system for asset compilation and management
|
|
- `controller.txt` - Controllers, routing, and Ajax endpoints
|
|
- `jqhtml.txt` - JQHTML component system and jQuery integration
|
|
|
|
### Naming Convention
|
|
|
|
Files use `alphanumeric_underscore.txt` format for consistency with RSX conventions.
|
|
|
|
## Usage
|
|
|
|
Read directly or access via `rsx:man` command:
|
|
```bash
|
|
php artisan rsx:man manifest_api
|
|
php artisan rsx:man controller
|
|
```
|
|
|
|
## Format
|
|
|
|
Each manual page follows standard sections:
|
|
- NAME - Component and brief description
|
|
- SYNOPSIS - Quick usage examples
|
|
- DESCRIPTION - Overview of functionality
|
|
- Subsections for specific features
|
|
- EXAMPLES - Practical code samples
|
|
- TROUBLESHOOTING - Common issues
|
|
- SEE ALSO - Related documentation
|
|
|
|
## Contributing
|
|
|
|
When adding new documentation:
|
|
1. Use `.txt` extension with underscores in filename
|
|
2. Follow existing format structure
|
|
3. Focus on API reference, not education
|
|
4. Include real examples from codebase
|
|
5. Keep descriptions terse but complete
|
|
|
|
## Future Documentation
|
|
|
|
Planned additions:
|
|
- `model.txt` - ORM and database models
|
|
- `auth.txt` - Authentication system
|
|
- `middleware.txt` - Request middleware
|
|
- `testing.txt` - Testing framework
|
|
- `commands.txt` - Artisan commands
|
|
- `debugging.txt` - Debug tools and techniques |