Frontend Source Reading Roadmap

This page is a lightweight roadmap for reading the Cabloy Basic frontend source.

Use it when your question is not yet “which exact runtime file should I open next?” but:

• where should I start reading?
• which topic cluster matches my question?
• should I begin with an overview page, an under-the-hood page, or a source-reading map?

Why this page exists

The current frontend docs now include:

• broad overview pages
• under-the-hood/runtime explanations
• source-reading maps
• many focused deep dives for specific runtime chains

That is good for depth, but it also means readers can reach the “which page next?” problem before they reach the “which file next?” problem.

This page solves that problem.

It is a chooser, not another runtime explainer.

How to use this page

Use this rule of thumb:

• if you are new to the topic, start with an overview page
• if you already understand the public concept and want runtime behavior, go to an under-the-hood page
• if you already know the topic and want the shortest path through source files, go to a source-reading map page
• if your question is very narrow and practical, go directly to the relevant deep dive page

Architecture spine: start here first

If you need the shortest path into the frontend mental model, start with these pages:

• Introduction
• Foundation
• Reading Zova for Vue Developers
• Zova vs Vue 3 Comparison
• Zova Reactivity Under the Hood
• Zova Source Reading Map

A practical reading order is:

1. Introduction
2. Foundation
3. Reading Zova for Vue Developers
4. Zova Source Reading Map

Topic cluster: app shell and startup

Start here when your question is about the root app host, startup, shell behaviors, or root composition.

Overview / concept pages

• App Startup Guide
• Behavior Guide

Focused deep dives

• Zova App Guide
• Root Behaviors Guide

Best next step

• if the question is “what is the root app host?” -> read Zova App Guide
• if the question is “how do app-wide behaviors wrap the routed tree?” -> read Root Behaviors Guide

Topic cluster: routing and routed hosts

Start here when your question is about route identity, routed hosts, tabs/stack, or task-level shell state.

Overview / concept pages

• Page Route Guide
• Router Tabs Introduction
• Router Tabs Overview

Under-the-hood / runtime pages

• A-Router Guide
• Zova Router Under the Hood
• Router View Hosts Guide
• Router Tabs Mechanism

Focused deep dives

• Page Meta Guide
• Router Tabs vs Stack
• Router Stack Guide

Best next step

• if the question is “how do routes become operational?” -> read A-Router Guide
• if the question is “which host owns the routed page instance?” -> read Router View Hosts Guide
• if the question is “what is the workbench meaning of router tabs?” -> read Router Tabs Overview
• if the question is “how does tabs state work?” -> read Router Tabs Mechanism
• if the question is “how should I choose between tabs and stack?” -> read Router Tabs vs Stack

Topic cluster: forms

Start here when your question is about ZForm, formMeta, page-entry forms, or form-driven shell state.

Overview / concept pages

• Form Guide

Under-the-hood / runtime pages

• Zova Form Under the Hood
• Zova Form Source Reading Map

Focused deep dives

• Form Scene to Page Meta Guide

Best next step

• if the question is “how does form runtime work?” -> read Zova Form Under the Hood
• if the question is “how does formScene become shell-visible state?” -> read Form Scene to Page Meta Guide

Topic cluster: resources and ModelResource

Start here when your question is about resource-driven CRUD pages, ModelResource, or route/resource/runtime assembly.

Overview / concept pages

• Model Resource Owner Pattern
• Using ModelResource in Your Module

Under-the-hood / runtime pages

• Rest Resource Under the Hood
• Rest Resource Source Reading Map

Focused deep dives

• A-Model Under the Hood
• ModelResource Internals Deep Dive
• Resource Entry Page Deep Dive
• Resource List Page Deep Dive
• Filter to Query to Select Data Flow Guide

Best next step

• if the question is “why does the resource owner exist?” -> read Model Resource Owner Pattern
• if the question is “how does the owner itself work internally?” -> read ModelResource Internals Deep Dive
• if the question is “how does the entry page runtime fit together?” -> read Resource Entry Page Deep Dive
• if the question is “how does the list page runtime fit together?” -> read Resource List Page Deep Dive
• if the question is “how does filter state become list data?” -> read Filter to Query to Select Data Flow Guide

Topic cluster: tables

Start here when your question is about ZTable, schema-driven columns, row/bulk actions, or table runtime.

Overview / concept pages

• Table Guide
• TableCell Authoring Cookbook

Under-the-hood / runtime pages

• Zova Table Under the Hood
• Zova Table Source Reading Map

Focused deep dives

• Table + Resource CRUD Cookbook
• Table Action Visibility and Permission Flow Guide
• Zova Table Controller Render Supplement

Best next step

• if the question is “how does the table runtime work?” -> read Zova Table Under the Hood
• if the question is “how do row/bulk actions become visible or hidden?” -> read Table Action Visibility and Permission Flow Guide

Topic cluster: server data and lower-level shared runtime

Start here when your question is about schema-driven server-data consumption, SDK/runtime loading, or lower-level metadata infrastructure.

Overview / concept pages

• Server Data
• SDK Guide
• OpenAPI SDK Guide
• API Schema Guide

Focused deep dives

• Generated Contract Consumption Specimen
• Generated Contract Consumption: List Branch
• Generated Contract Consumption: Entry Branch
• Generated Contract Consumption Verify Playbook
• Generated Contract Consumption Debug Checklist
• A-OpenAPI Under the Hood

Best next step

• if the question is “how do I consume the server-data ladder?” -> read Server Data
• if the question is “what does generated contract consumption look like in one practical frontend path?” -> read Generated Contract Consumption Specimen, then choose the list or entry branch
• if the question is “how do I prove or diagnose the generated-contract consumer path?” -> continue with Generated Contract Consumption Verify Playbook or Generated Contract Consumption Debug Checklist
• if the question is “how does the lower-level OpenAPI/schema runtime work?” -> read A-OpenAPI Under the Hood

Topic cluster: SSR

Start here when your question is about SSR orchestration, hydration, SEO meta, or SSR troubleshooting.

Overview / concept pages

• SSR Architecture Overview
• SSR Overview
• SSR Init Data
• SSR SEO Meta

Best next step

• if the question is “which side owns this SSR behavior?” -> read SSR Architecture Overview
• if the question is “is this document/meta or task-level shell state?” -> compare SSR SEO Meta with Page Meta Guide

Recent deep dives and maps

If you already know the cluster and want the most focused next page, these are the most useful recent deep dives/maps:

• Root Behaviors Guide
• A-Router Guide
• Router View Hosts Guide
• Form Scene to Page Meta Guide
• ModelResource Internals Deep Dive
• Resource Entry Page Deep Dive
• Resource List Page Deep Dive
• Filter to Query to Select Data Flow Guide
• Table Action Visibility and Permission Flow Guide
• A-OpenAPI Under the Hood

Final rule

When in doubt:

1. pick the cluster on this page
2. read the overview page first
3. move to the under-the-hood page
4. only then move to the source-reading map or deep dive

This roadmap is the chooser.

The detailed runtime explanations still belong to the cluster-specific pages.