Skip to content

🚀 Start Here — RevFramework

RevFramework is not a single script or drop-in component.

It is a set of modular systems designed to be:

  • composed
  • extended
  • adopted incrementally

This page shows you how to approach the framework, so you can start small, use what you need, and avoid extending the wrong layer.

🧭 The Big Picture

Every system follows the same documentation pattern:

Overview
→ Mental Model
→ Integration Surfaces
→ Public API
→ System Guarantees
→ FAQ
→ Teachable Panels
→ Samples

You do not need to read everything.

Start with the system you are using.
Go deeper only when you need to.

🟢 If You’re New

Start here:

  1. Overview
  2. Mental Model
  3. Teachable Panels
  4. Samples

👉 Stop here unless you need to extend something.

🟡 If You’re Integrating

Start here:

  1. Mental Model
  2. Public API
  3. Teachable Panels
  4. Samples
  5. Runtime Code

🔵 If You’re Extending

Start here:

  1. Mental Model (mandatory)
  2. Public API
  3. FAQ
  4. Integration Surfaces
  5. Teachable Panels
  6. Samples

🧪 Teachable Panels

Teachable Panels are more than demos.

They are:

  • live, in-editor learning tools
  • built against the public API
  • designed to show real runtime behaviour
  • useful for checking how a system is expected to behave

⚠ Source of truth
If documentation and Teachable Panels disagree, trust the panel behaviour first.

🔴 If Something Isn’t Working

Check in this order:

  1. FAQ
  2. Teachable Panel behaviour
  3. Sample scene
  4. Mental Model
  5. Public API

🧱 Runtime vs Docs vs Teaching

Layer Purpose
Runtime Actual system code
Documentation Explanation, contracts, and guarantees
Teaching Live validation and learning

🧠 Mental Model vs Public API

Mental Model Public API
Where logic belongs What you can call
Architecture rules Stable interfaces
How the system thinks How you integrate safely

You usually need both.

🧪 Samples

Samples are:

  • runnable
  • editable
  • intentionally focused

They are meant to be inspected, copied, and modified.

⚠️ What You Can Skip

You can skip:

  • systems you are not using
  • internal folders
  • advanced samples
  • integration pages for systems you do not own

🧩 One Rule

If you are unsure where something belongs:

👉 go back to the Mental Model

✅ TL;DR

  • Start with Overview → Mental Model
  • Use Teachable Panels to see behaviour live
  • Use Samples to learn by doing
  • Use Public API to integrate safely
  • Use FAQ to avoid wrong extension points

RevFramework is designed to prove behaviour, not just describe it.