# How the reference is organized

> The three layers of the CrossFly reference and the single-source rule.

Source: https://crossfly.dev/docs/reference/overview — CrossFly documentation. Full docs as one file: https://crossfly.dev/llms-full.txt

# How the reference is organized

This section is for **looking things up**, not for learning. To understand a concept, go to
[`concepts/`](/docs/concepts); to follow a step-by-step guide, [`cookbook/`](/docs/cookbook).

## The three layers of the reference
1. **Technical chapters** (the 36 files in `../../`) — the **canonical truth**,
   audited against the current source code (2026 audit). This is where "the truth about API X" lives.
2. **Generated Javadoc** (`gradle javadoc`) — the **exact signatures**, always in sync with the build. Use
   it for the granular detail of a method.
3. **Curated pages** (this folder) — they consolidate and **tabulate** what is scattered: widget
   catalog, `UIConstants` enums, cheat sheets, glossary.

## Single-source rule
Every fact has **one owner**. If you find the same information in two places, the owner is the **technical
chapter / Javadoc**, and the rest **links** to it (does not duplicate). This is the application of the
anti-duplication rule from the blueprint.

## ⚠️ Javadoc × code: trust the code
The CrossFly Javadoc is **outdated in places** (the 2026 modernization moved/renamed several
APIs). **Golden rule:** when they diverge, **trust the source code and this documentation, not the Javadoc
in isolation.** Known divergences are flagged on the affected pages (e.g., `AlphaAnimation` shows
`setAlpha` in the Javadoc, but the actual method is `alpha(float)`).

## How to find what you need
| You want… | Go to |
|---|---|
| the signature of a layout's `add()` | [Cheat sheets](/docs/reference/cheat-sheets) |
| the values of an enum (`RelPos`, `EditMode`…) | [Enums and `UIConstants`](/docs/reference/enums-uiconstants) |
| the properties of a widget | [Widget catalog](/docs/reference/widget-catalog) |
| to jump to a package/class API | [API index](/docs/reference/api-reference) |
| the meaning of a term | [Glossary](/docs/reference/glossary) |