This directory contains the English documentation used by the static website. It describes only the current implementation and does not preserve obsolete compatibility layers, temporary migrations, or unimplemented plans.
| Document | Description |
|---|---|
| Changelog | Public features, fixes, breaking changes, and maintenance work by release. |
| Architecture Overview | Package responsibilities, UAM and backend boundaries, host adapters, and primary data flows. |
| Editor Publish Settings | Actual editor setting files, properties, defaults, output resolution, and current publish behavior. |
| Publish Plugins | Plugin directories, manifests, lifecycle hooks, fallback behavior, and the boundary with FairyGUI Editor plugins. |
| Published Project Recovery Limits | Supported recovery scope, safety constraints, and information that cannot be reconstructed reliably from published artifacts. |
| Project XML Attribute Protocol | Canonical Project XML attributes, aliases, and node-level semantics. |
| Project XML DisplayList Tag Alignment | Alignment among raw XML tags, protocol variants, and editor DisplayListItem.type values. |
| FairyGUI Binary Package Format | V7 package blocks, component decoding, child records, and runtime-phase mapping. |
| Getting Started | Install the SDK and read your first FairyGUI project. |
| Packages and Tools | Choose the right package and runtime entrypoint. |
| Website Home | Entry points for guides, translated references, and the API. |
| Item | Policy |
|---|---|
| Audience | Repository maintainers, implementers, protocol contributors, and publishing-tool authors. |
| Source of truth | Documentation follows the current repository implementation; synchronization requirements are defined in AGENTS.md. |
| Root READMEs | README.md and README_EN.md provide navigation rather than protocol specifications. |
| Website build | Use pnpm docs:dev for local development. pnpm docs:build generates the public API reference and static site. |