Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revisions to metadata views documents to go into more depth about how to properly use each view #501

Merged
merged 5 commits into from
Jan 10, 2024

Conversation

joshuahannan
Copy link
Member

Closes onflow/flow-nft#166

Developers need more specific guidance on how to use metadata views. This PR updates the views document
to go into more depth about how to generally use reviews and gives more context, examples, and requirements for specific metadata views, namely royalties and traits.

Copy link

vercel bot commented Jan 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 8, 2024 5:49pm

Copy link
Contributor

@sisyphusSmiling sisyphusSmiling left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great doc!

/// The score of the rarity as a number
access(all) let score: UFix64?

/// The maximum value of score
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current comment is a bit ambiguous to me, but not sure if saying trait rarity is too prescriptive

Suggested change
/// The maximum value of score
/// The maximum trait rarity score

)
```

![MetadataViews.Display](display.png "Display")

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a blocker to this PR, but I recently wondered how we'd add SVG data to a Display view. Others might wonder as well and look to this section for guidance.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, just added a little blurb

@chasefleming
Copy link
Member

Love the images @joshuahannan !

@joshuahannan joshuahannan merged commit 06044a6 into main Jan 10, 2024
2 checks passed
@joshuahannan joshuahannan deleted the josh/views-additions branch January 10, 2024 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a Document for the docs site that explains what each metadata view is for and how to use it
3 participants