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

feat(docs): Add SYN to docs #3441

Merged
merged 1 commit into from
Dec 6, 2024
Merged

feat(docs): Add SYN to docs #3441

merged 1 commit into from
Dec 6, 2024

Conversation

abtestingalpha
Copy link
Collaborator

@abtestingalpha abtestingalpha commented Dec 6, 2024

Summary by CodeRabbit

  • New Features

    • Introduced comprehensive documentation for the $SYN token, detailing its governance role and liquidity venues.
    • Added a section listing blockchain addresses for the $SYN token across multiple chains, with links for verification.
  • Documentation

    • New documents created for $SYN token governance and contract addresses.

72b9dbe: docs preview link

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Walkthrough

The changes introduce new documentation for the $SYN token, a governance token for the Synapse Protocol. Two new sections are added: one detailing the token's governance structure and liquidity venues, and the other listing blockchain addresses associated with the token across various platforms. The documentation emphasizes that future emissions are governed by the DAO and provides links for further verification of the token's contract addresses.

Changes

File Path Change Summary
docs/bridge/docs/01-About/04-SYN.md Added new documentation for the $SYN token, detailing governance, liquidity venues, and token addresses.
docs/bridge/docs/05-Contracts/09-SYN.md Introduced a section listing blockchain addresses for the $SYN token across multiple chains with links.

Poem

In the land of tokens, bright and new,
The $SYN token hops, with a governance crew.
From Binance to Sushi, liquidity flows,
With addresses aplenty, where the blockchain glows.
A rabbit's delight in this digital dance,
Join the DAO's journey, give $SYN a chance! 🐇✨


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 288dc7e and 55b1d08.

📒 Files selected for processing (2)
  • docs/bridge/docs/01-About/04-SYN.md (1 hunks)
  • docs/bridge/docs/05-Contracts/09-SYN.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • docs/bridge/docs/01-About/04-SYN.md
  • docs/bridge/docs/05-Contracts/09-SYN.md

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

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: 55b1d08
Status: ✅  Deploy successful!
Preview URL: https://4404a585.sanguine-fe.pages.dev
Branch Preview URL: https://docs-syn.sanguine-fe.pages.dev

View logs

Copy link

codecov bot commented Dec 6, 2024

Bundle Report

Changes will decrease total bundle size by 3.12MB (-8.75%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sdk-router-@synapsecns/sdk-router-esm* 255.26kB 609 bytes (0.24%) ⬆️
sdk-router-@synapsecns/sdk-router-cjs* 117.55kB 312 bytes (0.27%) ⬆️
explorer-ui-server-cjs* 724.31kB 141.75kB (-16.37%) ⬇️
explorer-ui-client-array-push* 2.17MB 146.63kB (-6.34%) ⬇️
synapse-interface-client-array-push* 7.41MB 132.56kB (1.82%) ⬆️
synapse-interface-server-cjs* 1.66MB 160.49kB (10.74%) ⬆️
widget-cjs-esm* 271.27kB 2.03kB (-0.74%) ⬇️
docs-bridge-client-array-push 7.48MB 425.54kB (-5.39%) ⬇️
docs-bridge-server-cjs 11.83MB 3.05MB (-20.48%) ⬇️
synapse-constants-esm-cjs* 174.63kB 174.63kB (100%) ⬆️
synapse-constants-cjs-esm* 174.18kB 174.18kB (100%) ⬆️

ℹ️ *Bundle size includes cached data from a previous commit

@abtestingalpha abtestingalpha merged commit 31d6a3e into master Dec 6, 2024
31 checks passed
@abtestingalpha abtestingalpha deleted the docs/syn branch December 6, 2024 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant