Files
rspade_system/app/RSpade/man
root 77b4d10af8 Refactor filename naming system and apply convention-based renames
Standardize settings file naming and relocate documentation files
Fix code quality violations from rsx:check
Reorganize user_management directory into logical subdirectories
Move Quill Bundle to core and align with Tom Select pattern
Simplify Site Settings page to focus on core site information
Complete Phase 5: Multi-tenant authentication with login flow and site selection
Add route query parameter rule and synchronize filename validation logic
Fix critical bug in UpdateNpmCommand causing missing JavaScript stubs
Implement filename convention rule and resolve VS Code auto-rename conflict
Implement js-sanitizer RPC server to eliminate 900+ Node.js process spawns
Implement RPC server architecture for JavaScript parsing
WIP: Add RPC server infrastructure for JS parsing (partial implementation)
Update jqhtml terminology from destroy to stop, fix datagrid DOM preservation
Add JQHTML-CLASS-01 rule and fix redundant class names
Improve code quality rules and resolve violations
Remove legacy fatal error format in favor of unified 'fatal' error type
Filter internal keys from window.rsxapp output
Update button styling and comprehensive form/modal documentation
Add conditional fly-in animation for modals
Fix non-deterministic bundle compilation

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-13 19:10:02 +00:00
..

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:

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