docs: Split unified renderer_guide.md into core_sdk_spec.md and framework_adapter_spec.md for v0.9.1 and v1.0#1608
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a major restructuring of the A2UI documentation by splitting the architecture into a 'Core SDK Specification' and a 'Framework Adapter Specification'. It updates the documentation to reflect these changes, including updated agent implementation guides and cross-references. The review comments identified several broken path references in the documentation that pointed to the wrong version directory (v0_9 instead of v0_9_1). These have been noted for correction.
| - `specification/v0_9/json/server_to_client.json` (message envelopes) | ||
| - `specification/v0_9/json/catalogs/minimal/minimal_catalog.json` (your initial target) | ||
| - `specification/v0_9/docs/basic_catalog_implementation_guide.md` (for rendering and spacing rules for when you get to the basic catalog) | ||
| - `specification/v0_9/docs/basic_catalog_implementation_guide.md` (for functional specs and spacing rules for when you get to the basic catalog) |
There was a problem hiding this comment.
The path reference uses v0_9 instead of v0_9_1. Since this file is located under the specification/v0_9_1/ directory, all references to the specification paths in this section (including lines 517–520) should be updated to use v0_9_1 to ensure consistency and prevent broken links.
| - `specification/v0_9/docs/basic_catalog_implementation_guide.md` (for functional specs and spacing rules for when you get to the basic catalog) | |
| - specification/v0_9_1/docs/basic_catalog_implementation_guide.md (for functional specs and spacing rules for when you get to the basic catalog) |
| Thoroughly review: | ||
|
|
||
| - [A2UI Core SDK Specification](core_sdk_spec.md) (for state and message structures). | ||
| - `specification/v0_9/docs/basic_catalog_implementation_guide.md` (for rendering, typography, alignment, and spacing rules). |
There was a problem hiding this comment.
The path reference uses v0_9 instead of v0_9_1. Since this specification is for version v0.9.1 and resides in the specification/v0_9_1/ directory, the path should be updated to point to v0_9_1.
| - `specification/v0_9/docs/basic_catalog_implementation_guide.md` (for rendering, typography, alignment, and spacing rules). | |
| - specification/v0_9_1/docs/basic_catalog_implementation_guide.md (for rendering, typography, alignment, and spacing rules). |
|
|
||
| Build the Gallery App following the requirements in **Section 7**. | ||
|
|
||
| - Load JSON samples from `specification/v0_9/json/catalogs/minimal/examples/`. |
There was a problem hiding this comment.
The path reference uses v0_9 instead of v0_9_1. Update the path to use v0_9_1 to match the correct directory structure for this version.
| - Load JSON samples from `specification/v0_9/json/catalogs/minimal/examples/`. | |
| - Load JSON samples from specification/v0_9_1/json/catalogs/minimal/examples/. |
|
|
||
| - **Framework Library**: Implement all remaining UI widgets and traits (such as `Checkable`). | ||
| - **Tests**: Formulate and run comprehensive unit and integration test cases to verify static rendering, layout alignment, two-way bindings, and scoped actions. | ||
| - Update the Gallery App to load samples from `specification/v0_9/json/catalogs/basic/examples/`. |
There was a problem hiding this comment.
The path reference uses v0_9 instead of v0_9_1. Update the path to use v0_9_1 to match the correct directory structure for this version.
| - Update the Gallery App to load samples from `specification/v0_9/json/catalogs/basic/examples/`. | |
| - Update the Gallery App to load samples from specification/v0_9_1/json/catalogs/basic/examples/. |
Description of Changes
This Pull Request splits the unified, single-file
renderer_guide.mdinto two highly focused specifications across both versionv0.9.1andv1.0folders:core_sdk_spec.md(Framework-Agnostic Layer / Core SDK): Contains all agnostic definitions including:SurfaceGroupModel,SurfaceModel,SurfaceComponentsModel,ComponentModel,DataModelwith bubble/cascade pointers, and type-coercion table).ComponentContext,DataContext), capability schema-tagging/reference-generation rules, andMessageProcessor.FunctionApi,FunctionImplementation,Catalog), core-side standard Basic Catalog signatures, and expression evaluation logic (formatString).framework_adapter_spec.md(Framework-Specific / View Layer): Contains all visual, native-framework specifications including:ComponentImplementationfunctional/stateful methods,ComponentInstance, andSurfaceroot views).Checkabletraits) and visual catalogue overrides.Additionally, the workspace navigation instructions in
.agents/skills/a2ui-sdk-design/SKILL.mdhave been fully updated to reference the newly split files.Rationale
Separating the core data model and state logic from the UI rendering layer provides several key architectural advantages:
web_corebinders between React and Angular renderers).Testing/Running Instructions
Reviewers can verify the changes by doing the following:
specification/v0_9_1/docs/core_sdk_spec.md,specification/v0_9_1/docs/framework_adapter_spec.md,specification/v1_0/docs/core_sdk_spec.md, andspecification/v1_0/docs/framework_adapter_spec.mdexist and that the oldrenderer_guide.mdfiles have been correctly deleted..agents/skills/a2ui-sdk-design/SKILL.mdto confirm the navigation points correctly to the split specs.