Skip to content

Update schemas.mdx #1024

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

Merged
merged 4 commits into from
Oct 24, 2024
Merged

Update schemas.mdx #1024

merged 4 commits into from
Oct 24, 2024

Conversation

C-Emily-Furlong
Copy link
Contributor

adding two new schemas: metagov contribution and foundation mission request completed

Description

added two new schemas: metagov contribution and foundation mission request completed

Tests

none

Additional context
n/a

Metadata

adding two new schemas: metagov contribution and foundation mission request completed
@C-Emily-Furlong C-Emily-Furlong requested a review from a team as a code owner October 24, 2024 09:25
Copy link

netlify bot commented Oct 24, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit ae131ff
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/671a1cc375ba210008162439
😎 Deploy Preview https://deploy-preview-1024--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Oct 24, 2024

Warning

Rate limit exceeded

@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 34 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Files that changed from the base of the PR and between 6351973 and ae131ff.

Walkthrough

The pull request introduces updates to the schemas.mdx document, adding new schemas related to contributions and governance within the Optimism ecosystem. Key additions include the MetaGov Contribution, Foundation Mission Request Completed, Retro funding governance contribution, and Governance contribution schemas, each with unique identifiers and relevant fields. The document also marks certain schemas as archived, clarifying their historical significance and previous usage.

Changes

File Path Change Summary
pages/chain/identity/schemas.mdx Added new schemas: MetaGov Contribution, Foundation Mission Request Completed, Retro funding governance contribution, Governance contribution. Marked Retro funding application and Retro funding badgeholders schemas as archived.

Possibly related PRs

Suggested reviewers

  • sbvegan

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (1)
pages/chain/identity/schemas.mdx (1)

132-132: Consider removing or clarifying unused fields.

The fields "Impact" and "MetadataUrl" are marked as "not currently being used". Consider either:

  1. Removing these fields if they won't be used in the near future
  2. Adding a note about when they will be used
  3. Providing context about their intended purpose

Also applies to: 136-136

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between efb7da2 and 7db73ce.

📒 Files selected for processing (1)
  • pages/chain/identity/schemas.mdx (1 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. Avoid using all caps, italics, or bold for emphasis.
  • 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).
  • Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
  • For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
    "
🪛 GitHub Check: lint
pages/chain/identity/schemas.mdx

[warning] 124-124:
Found reference to undefined definition


[warning] 124-124:
Don’t use literal URLs without angle brackets


[warning] 130-130:
Missing final pipe in table fence


[warning] 135-135:
Cell should be padded with 1 space, not 6


[warning] 138-138:
Found reference to undefined definition


[warning] 138-138:
Don’t use literal URLs without angle brackets


[warning] 143-143:
Cell should be padded with 1 space, not 10

krofax and others added 2 commits October 24, 2024 11:01
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
pages/chain/identity/schemas.mdx (1)

131-131: Consider removing or clarifying unused fields.

The fields Impact and MetadataUrl are marked as "not currently being used". Consider either:

  1. Removing these fields if they're not planned for use
  2. Adding a note about their intended future use

Also applies to: 135-135

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7db73ce and 6351973.

📒 Files selected for processing (1)
  • pages/chain/identity/schemas.mdx (1 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. Avoid using all caps, italics, or bold for emphasis.
  • 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).
  • Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
  • For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
    "
🪛 GitHub Check: lint
pages/chain/identity/schemas.mdx

[warning] 129-129:
Missing final pipe in table fence


[warning] 134-134:
Cell should be padded with 1 space, not 6


[warning] 141-141:
Cell should be padded with 1 space, not 10

🔇 Additional comments (4)
pages/chain/identity/schemas.mdx (4)

124-124: Fix Markdown link formatting.

Remove the space between the link text and URL.

-### [MetaGov Contribution] (https://optimism.easscan.org/schema/view/0x84260b9102b41041692558a4e0cba6b7e5f9b813be56402c3db820c06dd4a5f1)
+### [MetaGov Contribution](https://optimism.easscan.org/schema/view/0x84260b9102b41041692558a4e0cba6b7e5f9b813be56402c3db820c06dd4a5f1)

125-136: Standardize table formatting.

Fix the following table formatting issues:

  1. Add missing final pipe in table rows
  2. Ensure consistent single-space padding in cells
🧰 Tools
🪛 GitHub Check: lint

[warning] 129-129:
Missing final pipe in table fence


[warning] 134-134:
Cell should be padded with 1 space, not 6


137-137: Fix Markdown link formatting.

Remove the space between the link text and URL.

-### [Foundation Mission Request Completed] (https://optimism.easscan.org/schema/view/0x649cc6df5af7561b66384405a62682c44e2428584d2f17a202ac3ef4506e2457)
+### [Foundation Mission Request Completed](https://optimism.easscan.org/schema/view/0x649cc6df5af7561b66384405a62682c44e2428584d2f17a202ac3ef4506e2457)

138-144: Standardize table formatting.

Ensure consistent single-space padding in table cells.

🧰 Tools
🪛 GitHub Check: lint

[warning] 141-141:
Cell should be padded with 1 space, not 10

@krofax krofax merged commit a54a671 into main Oct 24, 2024
7 of 8 checks passed
@krofax krofax deleted the C-Emily-Furlong-patch-1 branch October 24, 2024 10:16
@coderabbitai coderabbitai bot mentioned this pull request Jan 15, 2025
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.

2 participants