Skip to content

[SDK] Update package READMEs with correct naming and documentation links #7071

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

Conversation

joaquim-verges
Copy link
Member

@joaquim-verges joaquim-verges commented May 16, 2025


PR-Codex overview

This PR updates the documentation for the insight and engine packages, reflecting changes in their purpose and specifications. It also adds a link to the vault-sdk documentation.

Detailed summary

  • Updated packages/insight/README.md to introduce the Insight OpenAPI TypeScript Wrapper.
  • Revised packages/vault-sdk/README.md to include a link to its documentation.
  • Changed packages/engine/README.md to describe the Engine OpenAPI TypeScript wrapper.
  • Updated auto-generation source URL from Insight to Engine.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented May 16, 2025

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

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2025 0:56am
login ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2025 0:56am
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2025 0:56am
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2025 0:56am
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2025 0:56am

Copy link

changeset-bot bot commented May 16, 2025

⚠️ No Changeset found

Latest commit: a2a5299

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@joaquim-verges joaquim-verges marked this pull request as ready for review May 16, 2025 12:47
Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Contributor

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 54.18 KB (0%) 1.1 s (0%) 403 ms (+41.33% 🔺) 1.5 s
thirdweb (cjs) 194.07 KB (0%) 3.9 s (0%) 1.2 s (+21.1% 🔺) 5.1 s
thirdweb (minimal + tree-shaking) 5.68 KB (0%) 114 ms (0%) 165 ms (+959.04% 🔺) 278 ms
thirdweb/chains (tree-shaking) 524 B (0%) 11 ms (0%) 16 ms (+166.12% 🔺) 26 ms
thirdweb/react (minimal + tree-shaking) 19.53 KB (0%) 391 ms (0%) 159 ms (+274.25% 🔺) 549 ms

Copy link

codecov bot commented May 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.49%. Comparing base (d0c2ac6) to head (a2a5299).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7071      +/-   ##
==========================================
+ Coverage   55.47%   55.49%   +0.02%     
==========================================
  Files         909      909              
  Lines       58406    58406              
  Branches     4071     4069       -2     
==========================================
+ Hits        32401    32415      +14     
+ Misses      25902    25886      -16     
- Partials      103      105       +2     
Flag Coverage Δ
packages 55.49% <ø> (+0.02%) ⬆️

see 4 files with indirect coverage changes

🚀 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.

@joaquim-verges joaquim-verges merged commit 8f605d9 into main May 16, 2025
25 of 26 checks passed
@joaquim-verges joaquim-verges deleted the _SDK_Update_package_READMEs_with_correct_naming_and_documentation_links branch May 16, 2025 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant