docs(icons): Added @vibe/icons/meta to readme #2712
Merged
Conversation
This file contains 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
talkor
reviewed
Jan 12, 2025
packages/icons/README.md
Outdated
Comment on lines
34
to
39
| #### Using Meta Information | ||
|
|
||
| ```javascript | ||
| import iconsMetaData from "@vibe/icons/meta"; | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I think it worth mentioning what kind of metadata we provide
There was a problem hiding this comment.
I agree :) do you think we also need to explain for what use cases to use it?
talkor
reviewed
Jan 12, 2025
packages/icons/README.md
Outdated
| - `description`: A description of the icon's purpose or usage. | ||
| - `tags`: Associated tags as a comma-separated string. | ||
| - `category`: (Optional) Icon categories such as `Basic`, `Platform`, or `View`. | ||
| - `ignore`: (Optional) Indicates if the icon should be ignored. |
There was a problem hiding this comment.
I'd remove this as it's not relevant for the metadata but only for the catalog, no? @rivka-ungar
There was a problem hiding this comment.
The metadata contains this info...
There was a problem hiding this comment.
Yes but how will it benefit the users who use this metadata? 😅
There was a problem hiding this comment.
It is used internally to filter out icons we don't want to display in the catalog, so it probably doesn't need to be in the readme
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://monday.monday.com/boards/3532714909/pulses/8129522467