docs(a2ui): Update documentation to align with v0.9 specification #622
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gspencergoog
requested review from
dmandar,
jacobsimionato and
zeroasterisk
as code owners
- Replaced legacy v0.8 terminology (e.g., `beginRendering` -> `createSurface`, `usageHint` -> `variant`). - Updated schema examples for components and messages throughout the documentation. - Migrated legacy documentation to `docs/v0_8/` archive. - Updated guides and concepts to reflect v0.9 changes. - Add 'fit' and 'variant' properties to Image component documentation. - Clarify 'updateDataModel' value optionality (omission implies deletion). - Add new 'Client-Side Functions' reference page and link it. - Mention client-side formatting in best practices.
gspencergoog
force-pushed
the
update_docs
branch
from
409483c to
519a672
Compare
- Move v0.8 documentation to `docs/specification/`. - Add wrapper files for v0.8, v0.9, v0.10 specifications, evolution guides, and extension specs. - Update mkdocs.yaml to reflect new structure and include all relevant documents. - Update prepare_docs.py to handle file copying, JSON flattening, and comprehensive link rewriting for all versions. - Fix internal links in markdown files to point to correct relative paths. - Remove deprecated `docs/v0_8` directory.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This updates the docs folder to describe the 0.9 specification instead of 0.8. I added disclaimers that the renderers are not yet up to spec, but I think it's still a little odd to have docs for 0.9 and no examples yet.
Better that the docs represent the current spec, though.