Updates readme #3268
Updates readme #3268
Conversation
WalkthroughThe changes in this pull request primarily focus on updating the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
packages/synapse-constants/README.md (2)
15-20: LGTM! Add language specification to the code block.The addition of build instructions is helpful. However, the fenced code block is missing a language specification.
Apply this change to add the language specification:
-``` +```bash yarn build<details> <summary>🧰 Tools</summary> <details> <summary>🪛 Markdownlint</summary><blockquote> 19-19: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </details> --- `37-41`: **LGTM! Consider creating GitHub issues for TODO items.** The addition of a TODO section provides a clear roadmap for future documentation improvements. To ensure better visibility and management of these tasks, consider creating GitHub issues for each item. Would you like me to create GitHub issues for these TODO items? I can use the GitHub CLI to create the issues with appropriate titles and descriptions. </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Files that changed from the base of the PR and between 2b05e512de7370077d1f1d531dbb9587438d887e and 010b0aa0a865336fb6fb5da92c3aa676c7bbe53d. </details> <details> <summary>📒 Files selected for processing (1)</summary> * packages/synapse-constants/README.md (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 Markdownlint</summary><blockquote> <details> <summary>packages/synapse-constants/README.md</summary><blockquote> 19-19: null Fenced code blocks should have a language specified (MD040, fenced-code-language) </blockquote></details> </blockquote></details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>packages/synapse-constants/README.md (1)</summary><blockquote> `23-34`: **LGTM! Clear and concise usage examples.** The updated usage section provides clear and concise examples for importing supported tokens and chains, as well as importing a specific token. The examples consistently use the new package name. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Deploying sanguine-fe with
|
| Latest commit: |
010b0aa
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0c238376.sanguine-fe.pages.dev |
| Branch Preview URL: | https://synapse-constants-update-rea.sanguine-fe.pages.dev |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3268 +/- ##
===================================================
+ Coverage 30.68788% 31.76937% +1.08148%
===================================================
Files 447 427 -20
Lines 29787 28496 -1291
Branches 82 82
===================================================
- Hits 9141 9053 -88
+ Misses 19797 18597 -1200
+ Partials 849 846 -3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Bundle ReportChanges will increase total bundle size by 348.81kB (1.1%) ⬆️. This is within the configured threshold ✅ Detailed changes
|
Summary by CodeRabbit
@synapsecns/synapse-constants.