Add descriptions to schemas for all catalog items to improve generation quality

Open Beginner friendly
#1,841 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
documentation

Research direction

Look at the linked PR #498 in the flutter/genui repository to understand the pattern for adding descriptions to schemas. Identify the catalog item schemas in the a2ui codebase, likely in a directory like schemas/ or src/schemas/. Add clear, descriptive text to each schema's definition. Verify the changes do not break existing schema validation tests.

Written by the indexing model from the issue text.

Description

component: genui P2 status: first-line-handled

↴ Ported from flutter/genui#554 — originally opened by jacobsimionato on 2025-11-18.
Original labels: P2, front-line-handled, second-line-triaged, quality


Branched from https://github.com/flutter/genui/issues/448

This is a stop-gap measure, because these descriptions will actually need to be added at the A2UI level and then eventually copied to Gen UI. But it's worth us still improving these slightly where we can.

@victoreronmosele has a PR out for this at https://github.com/flutter/genui/pull/498

Dominant language
TypeScript
Stars
16.4k
Forks
1.3k
Avg merge
3d 5h
Merged PRs (30d)
117

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from a2ui-project/a2ui

All issues in a2ui-project/a2ui

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.