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

docs: simplify README, fix incorrect LSP3 reference and improve Getting Started section #431

Merged
merged 4 commits into from
May 7, 2024

Conversation

CJ42
Copy link
Collaborator

@CJ42 CJ42 commented May 6, 2024

Easier to review can be by looking at the preview of the edited Markdown docs in the branch:

@CJ42 CJ42 marked this pull request as draft May 6, 2024 13:39
@CJ42 CJ42 marked this pull request as ready for review May 6, 2024 13:48
README.md Outdated Show resolved Hide resolved
// Part of LSP3-UniversalProfile Schema
// https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-3-UniversalProfile.md
// Part of LSP3-Profile-Metadata Schema
// https://github.com/lukso-network/LIPs/blob/master/LSPs/LSP-3-Profile-Metadata.md
Copy link
Contributor

Choose a reason for hiding this comment

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

FMI: What s the difference btw LSP3Profile and SupportedStandards:LSP3Profile as a schema?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

LSP3Profile = contains the VerifiableURI that links to the JSON file. It is the actual profile metadata

SupportedStandards:LSP3Profile = it is just a data key to confirm that this contract supports the LSP3 Metadata standard, and contain a certain set of keys (only LSP3Profile in this case).

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@magalimorin18 magalimorin18 left a comment

Choose a reason for hiding this comment

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

nice! super clear

@CJ42 CJ42 merged commit 58575e9 into develop May 7, 2024
2 checks passed
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.

3 participants