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

added a glosary term #871

Merged
merged 1 commit into from
Sep 6, 2024
Merged

added a glosary term #871

merged 1 commit into from
Sep 6, 2024

Conversation

krofax
Copy link
Contributor

@krofax krofax commented Aug 29, 2024

Description

A clear and concise description of the features you're adding in this pull request.

Tests

Please describe any tests you've added. If you've added no tests, or left important behavior untested, please explain why not.

Additional context

Add any other context about the problem you're solving.

Metadata

@krofax krofax requested a review from a team as a code owner August 29, 2024 21:09
Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

The changes introduce a new section titled "Delegation" in the governance documentation of the Optimism Token House. This section explains the concept of delegation, the role of delegates, and the implications for token holders, emphasizing the retention of token ownership and the flexibility to change delegates.

Changes

Files Change Summary
pages/connect/resources/glossary.mdx Added a new section "Delegation" detailing the delegation of voting power and its implications.

Possibly related issues

  • [FAQ] Delegation #852: This issue proposes adding an FAQ item about delegation, which aligns with the new section introduced in this PR, providing further clarification on the concept of delegation in governance.

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 40707a2 and 8fe5468.

Files selected for processing (1)
  • pages/connect/resources/glossary.mdx (1 hunks)
Additional context used
Path-based instructions (1)
pages/connect/resources/glossary.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 not posted (1)
pages/connect/resources/glossary.mdx (1)

39-44: Improve clarity and consistency.

The section is well-written but can be improved for clarity and consistency. Apply the following changes:

  1. Use proper nouns in place of personal pronouns.
  2. Ensure proper capitalization and grammar.
  3. Apply the Oxford comma.

Apply this diff to improve the section:

-Refers to the process of assigning the voting power of your tokens to a designated community member, known as a delegate. 
-Delegates are individuals who have volunteered to actively participate in the governance of the Optimism Token House. 
-By delegating your voting power, you enable these delegates to vote on governance matters on your behalf, while you retain full ownership of your tokens and the freedom to use them as you wish. 
-You can also change your chosen delegate at any time, allowing for flexibility in how your voting power is represented in the governance process.
+Refers to the process of assigning the voting power of tokens to a designated community member, known as a delegate.
+Delegates are individuals who have volunteered to actively participate in the governance of the Optimism Token House.
+By delegating voting power, token holders enable these delegates to vote on governance matters on their behalf, while retaining full ownership of their tokens and the freedom to use them as they wish.
+Token holders can also change their chosen delegate at any time, allowing for flexibility in how their voting power is represented in the governance process.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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

netlify bot commented Aug 29, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 8fe5468
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/66d0e3863fe459000853c831
😎 Deploy Preview https://deploy-preview-871--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.

@cpengilly cpengilly merged commit a06498b into main Sep 6, 2024
8 checks passed
@cpengilly cpengilly deleted the glossary-delegation branch September 6, 2024 22:34
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.

[FAQ] Delegation
2 participants