docs: clarify Pro icons metadata setup (icons.json vs icon-families.json)#295
Open
kingdomseed wants to merge 1 commit intofluttercommunity:masterfrom
Open
docs: clarify Pro icons metadata setup (icons.json vs icon-families.json)#295kingdomseed wants to merge 1 commit intofluttercommunity:masterfrom
kingdomseed wants to merge 1 commit intofluttercommunity:masterfrom
Conversation
…son) - Separate .otf and metadata steps - Explain icons.json vs icon-families.json as alternative formats - Clarify: copy/rename one file to lib/fonts/icons.json, do not merge - Add Git LFS note for large metadata Closes fluttercommunity#284
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation for setting up Font Awesome Pro icons by clarifying the confusing instructions about icons.json vs icon-families.json files, directly addressing issue #284 where users were confused about whether to merge or replace these files.
Changes:
- Separates .otf font file setup from metadata file setup into distinct steps
- Clarifies that
icons.jsonandicon-families.jsonare alternative format options (not to be merged) - Adds practical guidance for handling large metadata files (100+ MB) using Git LFS
- Improves the filename space-to-dash conversion example with a concrete before/after
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Closes #284
Clarifies the Pro icons setup documentation to resolve confusion about icons.json vs icon-families.json: