🎯 GENERIC Framework Documentation

Framework-agnostic guides for any DSL-based CRUD application

This documentation applies to ANY application built with this framework — it is not specific to any one app.

📚 Documentation Layers

Getting Started (For New Users)

Start here if you're using this application for the first time: - Welcome - What is this application? - The Interface - Tour of the screen - Your First Record - Step-by-step guide - Navigation & Relationships - How records connect

Time investment: 15-20 minutes for complete onboarding

Core Concepts (Understanding the Framework)

Learn how the framework works: - What Is DSL? - How applications are built - CRUD Operations - Create, Read, Update, Delete - Forms & Validation - Filling in data correctly - Hierarchical Navigation - Parent-child relationships - Soft Delete Pattern - How deletion works

Time investment: 30-40 minutes to understand framework concepts

Operations (Running & Deploying)

Setting up and running the application: - Local Development - Running on your computer - Deployment Patterns - Moving to production - Environment Variables - Configuration settings

Time investment: 20-30 minutes to set up

🎯 Quick Navigation by User Type

I'm a New User

→ Start with Welcome → Then The Interface → Then Your First Record → Then Navigation & Relationships

Total time: 15-20 minutes

I'm Setting Up Development Locally

→ Local Development → Reference Environment Variables

Total time: 20-30 minutes

I'm Deploying to Production

→ Deployment Patterns → Reference Environment Variables

Total time: 30-45 minutes

I'm a New Developer

→ What Is DSL? - Understand framework → CRUD Operations - Data operations → Hierarchical Navigation - Relationships

Total time: 30-40 minutes

📊 Documentation Statistics

  • Getting Started: 4 guides
  • Core Concepts: 5 concept docs
  • Operations: 3 operational guides
  • Total: 12 files covering framework fundamentals
  • Main Portal Index - Complete navigation hub
  • FAQ - Quick answers to common questions
  • Application Specific - your application's own section in the sidebar (below Framework Guides)
  • Developer Reference - Framework internals and architecture
  • CLAUDE.md (repository root, not served here) - Project guidelines and standards

🆘 Didn't Find What You're Looking For?

  1. Check the main INDEX: Documentation Index
  2. Search FAQ: FAQ for common issues
  3. Application specifics: your application's section in the sidebar

✅ Key Takeaway

This documentation explains how the framework works. It applies to: - Any DSL-based CRUD application - Any data structure - Any deployment platform

It does NOT explain: - Domain-specific terminology (see your application's own docs section) - How to extend the framework (see Developer docs) - Application-specific workflows (see your application's own docs section)

New here? Start with Welcome →

Need help? Check the Main INDEX or FAQ →