Skip to content

fix: remove duplicated footnotes from Governance - Token page#515

Merged
alfetopito merged 3 commits intomainfrom
fix/governance-token-footnotes
Jul 3, 2025
Merged

fix: remove duplicated footnotes from Governance - Token page#515
alfetopito merged 3 commits intomainfrom
fix/governance-token-footnotes

Conversation

@cowdan
Copy link
Contributor

@cowdan cowdan commented Jul 3, 2025

Description

  • Remove duplicate footnotes
  • Add Polygon Bridge to the footnotes

Screenshot 2025-07-03 at 09 57 33

Test

Go to the Token page, click on any superscript link and the page should scroll down to the footnotes.

Screenshot 2025-07-03 at 09 59 00

  • Only one footnote block is visible
  • Polygon Bridge is added to the footnotes, and it links to Polygon Bridge

Summary by CodeRabbit

  • Documentation
    • Updated information to include the Polygon Bridge as an official bridge for the COW token on Polygon.
    • Expanded footnote to mention all supported bridges.
    • Removed a redundant footnotes section for clarity.

@vercel
Copy link

vercel bot commented Jul 3, 2025

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

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Jul 3, 2025 9:51am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 3, 2025

Walkthrough

The documentation for the COW token was updated to add the Polygon Bridge as an official bridge for its bridged versions on Polygon. The footnote about bridged tokens was expanded to include this bridge, and a redundant footnotes section at the end of the document was removed.

Changes

File(s) Change Summary
docs/governance/token.md Added Polygon Bridge to bridged tokens footnote, updated bridge list, removed redundant footnotes section

Possibly related PRs

  • Update token.md #495: Updates the same documentation file, restructuring and expanding tokenomics and governance details, including changes to footnotes.

Poem

🐇
A bridge to Polygon, now in the lore,
COW token travels, its bridges are four.
Footnotes are cleaner, no more repeat,
Documentation updates—succinct and neat.
Across the chains, our token will roam,
On bridges official, it finds a new home!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cbae876 and 6a3b6c9.

📒 Files selected for processing (1)
  • docs/governance/token.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/governance/token.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

@cowdan cowdan marked this pull request as ready for review July 3, 2025 09:01
@cowdan cowdan requested a review from a team as a code owner July 3, 2025 09:01
@cowdan cowdan requested review from a team and elena-zh July 3, 2025 09:01
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

🧹 Nitpick comments (1)
docs/governance/token.md (1)

24-24: Standardise bridge naming & capitalisation

Minor style nit — the list mixes capitalisation styles (“Omni bridge”, “Arbitrum One bridge”, “Arbitrum one”). For consistency with the official bridge names and the rest of the docs, capitalise the proper nouns uniformly:

-[Omni bridge](https://gnosisscan.io/address/0xf6A78083ca3e2a662D6dd1703c939c8aCE2e268d#code) for Gnosis Chain, [Arbitrum One bridge](https://arbiscan.io/address/0x09e9222e96e7b4ae2a407b98d48e330053351eee#code) for Arbitrum one, [Superbridge](https://basescan.org/tx/0xf76a915b7db279a4e559dbc382462e23cb63615f3d3a87ddf36bd96cedf4ca56) for Base, and [Polygon One Bridge](https://portal.polygon.technology/bridge) for Polygon.
+[OmniBridge](https://gnosisscan.io/address/0xf6A78083ca3e2a662D6dd1703c939c8aCE2e268d#code) for Gnosis Chain, [Arbitrum One Bridge](https://arbiscan.io/address/0x09e9222e96e7b4ae2a407b98d48e330053351eee#code) for Arbitrum One, [Superbridge](https://basescan.org/tx/0xf76a915b7db279a4e559dbc382462e23cb63615f3d3a87ddf36bd96cedf4ca56) for Base, and [Polygon One Bridge](https://portal.polygon.technology/bridge) for Polygon.

Keeps branding tidy and avoids potential reader confusion.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0bb7bf6 and cbae876.

📒 Files selected for processing (1)
  • docs/governance/token.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: alfetopito
PR: cowprotocol/docs#505
File: docs/cow-protocol/tutorials/cow-swap/custom-links.md:75-76
Timestamp: 2025-06-16T16:45:56.918Z
Learning: Polygon completed a major token migration from MATIC to POL on September 4, 2024. As part of this upgrade, the wrapped token symbol on Polygon PoS was automatically changed from WMATIC to WPOL (Wrapped Polygon Ecosystem Token). The contract address 0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270 on Polygon now represents WPOL, not WMATIC.
docs/governance/token.md (1)
Learnt from: alfetopito
PR: cowprotocol/docs#505
File: docs/cow-protocol/tutorials/cow-swap/custom-links.md:75-76
Timestamp: 2025-06-16T16:45:56.918Z
Learning: Polygon completed a major token migration from MATIC to POL on September 4, 2024. As part of this upgrade, the wrapped token symbol on Polygon PoS was automatically changed from WMATIC to WPOL (Wrapped Polygon Ecosystem Token). The contract address 0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270 on Polygon now represents WPOL, not WMATIC.

@alfetopito alfetopito merged commit 5667cc3 into main Jul 3, 2025
6 checks passed
@alfetopito alfetopito deleted the fix/governance-token-footnotes branch July 3, 2025 09:59
@github-actions github-actions bot locked and limited conversation to collaborators Jul 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants