Files
rspade_system/app/RSpade/man
root 84ca3dfe42 Fix code quality violations and rename select input components
Move small tasks from wishlist to todo, update npm packages
Replace #[Auth] attributes with manual auth checks and code quality rule
Remove on_jqhtml_ready lifecycle method from framework
Complete ACL system with 100-based role indexing and /dev/acl tester
WIP: ACL system implementation with debug instrumentation
Convert rsx:check JS linting to RPC socket server
Clean up docs and fix $id→$sid in man pages, remove SSR/FPC feature
Reorganize wishlists: priority order, mark sublayouts complete, add email
Update model_fetch docs: mark MVP complete, fix enum docs, reorganize
Comprehensive documentation overhaul: clarity, compression, and critical rules
Convert Contacts/Projects CRUD to Model.fetch() and add fetch_or_null()
Add JS ORM relationship lazy-loading and fetch array handling
Add JS ORM relationship fetching and CRUD documentation
Fix ORM hydration and add IDE resolution for Base_* model stubs
Rename Json_Tree_Component to JS_Tree_Debug_Component and move to framework
Enhance JS ORM infrastructure and add Json_Tree class name badges

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-23 21:39:43 +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