Add descriptions to catalog items schema objects #523
Conversation
|
|
||
| final _schema = S.object( | ||
| description: ''' | ||
| A catalog item representing a Material Design elevated button. |
There was a problem hiding this comment.
Could you remove all references to Material Design from this? The idea is that the LLM just needs to know about the API for the components and their functional role, rather than the specifics of their implementation.
| A catalog item representing a layout widget that displays its children in a | ||
| vertical array. | ||
| This widget is analogous to Flutter's [Column] widget. It arranges a list of |
There was a problem hiding this comment.
The same here - no need to mention Flutter, because the use of Flutter is an implementation detail that the LLM does not need to know about. I think you could just remove the second line here, and perhaps in some of the others too, though I do think the extra info is helpful in some cases e.g. checkbox above, where it explains the data binding relationship.
| A catalog item representing a text heading. | ||
| Headings are used to title sections of content. The visual appearance is | ||
| determined by the `level` parameter, which maps to standard [TextTheme] |
There was a problem hiding this comment.
No need to mention TextTheme. The heading levels are a generic concept, common to HTML, Flutter, Markdown etc.
|
Thank you so much for this PR, Victor!!! |
|
Thanks for the feedback @jacobsimionato. Will attend to it soon. |
victoreronmosele
force-pushed
the
add-description-catalog-items
branch
from
fb0f807 to
f184ff5
Compare
victoreronmosele
force-pushed
the
add-description-catalog-items
branch
from
f184ff5 to
34238ba
Compare
|
I've updated the descriptions @jacobsimionato. |
2 participants
Description
This PR adds descriptions to the schemas of the catalog items.
The descriptions are copied from the doc comments of the catalog item variables.
Fixes #554
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-devrel channel on Discord.