a2ui-project / a2ui-project/a2ui

[FEATURE]: Additional per-component metadata for each catalog component

Đang mở
#2,368 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
P2 status: first-line-handled
Ngôn ngữ chính
TypeScript
Star
16.4k
Fork
1.3k
Merge trung bình
2 ngày 13 giờ
Pull request đã merge (30 ngày)
134

Mô tả

- [x ] I have searched the existing issues to make sure this feature has not already been requested.

## Is your feature request related to a problem? Please describe.

Currently all metadata about a component must be placed into either the `name` or `description` properties. When richer semantic information is available, it must be jammed into the `description` field with some catalog-dependent and fixed format.

## Describe the Proposed Solution

Add additional optional metadata properties to each component at the `description` level, with known semantics.

Recommendations:

1. Add `usage`: Explicit usage instructions such as `"Use small for lower emphasis, or when space is tight. Use large for higher emphasis, or when number is important. Text label above 999 should cap at \"999+\"."`
1. Add `similar_components`: A map of component names to instructions for selecting the component, e.g. `{ "Chip": "Use for longer labels.", ...}`
1. Update the catalog-to-prompt logic to include these fields.

## Describe Alternatives Considered

Jamming these into the description. Prevents future progressive disclosure opportunities and any optimizations on how to best present these to the agent (because the format in which they are jammed into the description becomes fixed by the catalog owner).

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Look at the component catalog structure, likely in a file like `src/catalog/types.ts` or similar, to understand the existing `name` and `description` properties. Identify where components are defined and where the catalog-to-prompt logic resides. Add the new optional fields (`usage`, `similar_components`) to the component metadata interface and update the prompt generation logic to include them. Test by verifying that a sample component with the new metadata is correctly processed and appears in generated prompts.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
typescript
Lĩnh vực
developer-experience, documentation
Loại issue
Tính năng
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Sôi nổi
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
65/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.