OpenFairyGUI Documentation
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.
Documentation index
| Document | Description |
|---|---|
| Repository Development and Verification | Reproducible setup, references, task routing, verification scope and PR gates. |
| Development Task Recipes | XML fields, UAM operations, Backend/MCP integration, publish diagnosis and protocol evidence routes. |
| Runnable Examples and Consumer Verification | Reward panel states, layout animation, and card generation, SDK/MCP edit verification, isolated tarballs, real browser storage, and publish/limited recovery. |
| Contract Sources and Operation Discovery | Core/Backend-derived operations, MCP input/output schemas, binary transport and drift checks. |
| Diagnostics and Recovery | Diagnostic ownership, per-code guides and read-only recovery starting points; no automatic repair. |
| Installed Documentation and Product Diagnosis | CLI/MCP shared offline corpus, thin skill and read-only product doctor. |
| Real Agent Task Evaluations | Ten real-tarball tasks, deterministic oracles, manual model observations and failure reproduction. |
| Project Validation | Shared project validation reports and API/CLI/Backend/MCP behavior. |
| 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 | Local MCP setup, installed-version checks, a first verifiable edit, and CLI / SDK entrypoints. |
| Packages and Tools | Choose the right package and runtime entrypoint. |
| Website Home | Entry points for guides, translated references, and the API. |
Conventions
| Item | Policy |
|---|---|
| Audience | Agent and tool users, editor-host developers, repository maintainers, and protocol contributors. |
| 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. |