Skip to content

fix: update readme docs#1354

Merged
elribonazo merged 1 commit into
mainfrom
fix/multichain-quick-docs
Oct 2, 2025
Merged

fix: update readme docs#1354
elribonazo merged 1 commit into
mainfrom
fix/multichain-quick-docs

Conversation

@elribonazo

@elribonazo elribonazo commented Oct 2, 2025

Copy link
Copy Markdown
Contributor

Explanation

Simple PR just including docs

References

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

Note

Updates READMEs to add build/dev/test instructions and streamline the playground docs.

  • Docs:
    • packages/sdk-multichain-ui/README.md: Add package overview and usage, including development (yarn dev/yarn start) and build instructions.
    • packages/sdk-multichain/README.md: Add local build guidance (requires building sdk-multichain-ui first) and testing commands (yarn test, yarn test:ci).
    • playground/multichain-react/README.md: Simplify by removing environment configuration/Helius sections; keep installation and usage basics.

Written by Cursor Bugbot for commit e1d7fe9. This will update automatically on new commits. Configure here.

@elribonazo elribonazo marked this pull request as ready for review October 2, 2025 15:50
@elribonazo elribonazo requested a review from a team as a code owner October 2, 2025 15:50
@codecov

codecov Bot commented Oct 2, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.99%. Comparing base (ac8f8c3) to head (e1d7fe9).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1354   +/-   ##
=======================================
  Coverage   74.99%   74.99%           
=======================================
  Files         184      184           
  Lines        4519     4519           
  Branches     1108     1108           
=======================================
  Hits         3389     3389           
  Misses       1130     1130           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sonarqubecloud

sonarqubecloud Bot commented Oct 2, 2025

Copy link
Copy Markdown

@elribonazo elribonazo enabled auto-merge (squash) October 2, 2025 16:51
@elribonazo elribonazo merged commit 9bfd247 into main Oct 2, 2025
44 checks passed
@elribonazo elribonazo deleted the fix/multichain-quick-docs branch October 2, 2025 17:26
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