Update schemas to add new application attestation schema.mdx #944
Conversation
WalkthroughThe pull request includes updates to the schema references and descriptions in the document related to Retro Funding applications. Key changes involve the modification of the schema UID for the "Retro Funding Application," the addition of an archived version of this schema, and clarifications regarding metadata fields for related schemas. These updates aim to enhance the clarity and accuracy of schema definitions relevant to the OP Mainnet. Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
pages/chain/identity/schemas.mdx (1)
150-162: Approval: Archived Retro Funding Application schema addedThe addition of the archived Retro Funding Application schema for Rounds 4 and 5 is a good practice. It maintains historical information and ensures clarity about which schema was used for different rounds.
Consider rephrasing the description slightly for improved clarity:
-Used to identify a project's application to a specific Retro Funding Round. This attestation was used for Retro Funding Rounds 4 and 5. +Used to identify a project's application for Retro Funding Rounds 4 and 5. This attestation schema is no longer in use for current rounds.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/chain/identity/schemas.mdx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/chain/identity/schemas.mdx (1)
Pattern
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Use bold for prominence instead of all caps or italics.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
"
🔇 Additional comments (2)
pages/chain/identity/schemas.mdx (2)
71-72: Approval: New metadata fields added to schemaThe addition of
metadataTypeandmetadataUrlfields enhances the schema's flexibility. The descriptions are clear and provide useful information about how to access and interpret the metadata.
62-74: Approval: New Retro Funding Application schema addedThe addition of a new schema for Retro Funding Applications (Round 6 and beyond) is appropriate. The change in schema UID from the previous version is significant and clearly documented.
To ensure consistency across the documentation, please run the following script:
✅ Verification successful
Schema UID consistency verified
The new schema UID
0x2169b74bfcb5d10a6616bbc8931dc1c56f8d1c305319a9eeca77623a991d4b80is consistently used inpages/chain/identity/schemas.mdx.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify that the new schema UID is consistently used across the documentation rg --type mdx "0x2169b74bfcb5d10a6616bbc8931dc1c56f8d1c305319a9eeca77623a991d4b80"Length of output: 110
Script:
#!/bin/bash # Verify that the new schema UID is consistently used across .mdx files rg "0x2169b74bfcb5d10a6616bbc8931dc1c56f8d1c305319a9eeca77623a991d4b80" --glob '*.mdx'Length of output: 436
Description
From Round 6 we have changed the application attestation schema that is issued when someone applies for Retro Funding. I added that schema and moved the old one to the archive
Tests
none
Additional context
n/a
Metadata