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(storage): add JSON object upload example and documentation #4796

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

joaquim-verges
Copy link
Member

@joaquim-verges joaquim-verges commented Sep 24, 2024

Problem solved

Short description of the bug fixed or feature added


PR-Codex overview

This PR enhances the documentation for the upload and download functions in the thirdweb/storage module by adding examples for uploading JSON objects and restructuring section headers for clarity.

Detailed summary

  • Added an example for uploading JSON objects in packages/thirdweb/src/storage/upload.ts.
  • Changed section header from "### Download from IPFS" to "## Download from IPFS" in apps/portal/src/app/typescript/v5/storage/page.mdx.
  • Changed section header from "### Upload to IPFS" to "## Upload to IPFS" in apps/portal/src/app/typescript/v5/storage/page.mdx.
  • Included an example for uploading JSON objects in apps/portal/src/app/typescript/v5/storage/page.mdx.

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

Copy link

vercel bot commented Sep 24, 2024

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 Sep 24, 2024 11:57pm
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 24, 2024 11:57pm
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 24, 2024 11:57pm
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 24, 2024 11:57pm

Copy link

graphite-app bot commented Sep 24, 2024

Your org has enabled the Graphite merge queue for merging into main

Add the label “merge-queue” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix.

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

@github-actions github-actions bot added Portal Involves changes to the Portal (docs) codebase. packages labels Sep 24, 2024
Copy link
Member Author

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

Join @joaquim-verges and the rest of your teammates on Graphite Graphite

Copy link
Contributor

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 41.91 KB (0%) 839 ms (0%) 3 s (+24.76% 🔺) 3.9 s
thirdweb (cjs) 101.47 KB (0%) 2.1 s (0%) 7.8 s (+14.75% 🔺) 9.8 s
thirdweb (minimal + tree-shaking) 4.82 KB (0%) 97 ms (0%) 241 ms (-30.22% 🔽) 337 ms
thirdweb/chains (tree-shaking) 498 B (0%) 10 ms (0%) 125 ms (+84.85% 🔺) 135 ms
thirdweb/react (minimal + tree-shaking) 16.73 KB (0%) 335 ms (0%) 433 ms (-35.22% 🔽) 768 ms

Copy link

codecov bot commented Sep 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.11%. Comparing base (e2b3484) to head (e5cae90).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4796      +/-   ##
==========================================
- Coverage   49.11%   49.11%   -0.01%     
==========================================
  Files        1052     1052              
  Lines       56786    56786              
  Branches     3889     3889              
==========================================
- Hits        27892    27890       -2     
- Misses      28261    28263       +2     
  Partials      633      633              
Flag Coverage Δ *Carryforward flag
legacy_packages 65.68% <ø> (ø) Carriedforward from e2b3484
packages 45.18% <ø> (-0.01%) ⬇️

*This pull request uses carry forward flags. Click here to find out more.

Files with missing lines Coverage Δ
packages/thirdweb/src/storage/upload.ts 71.42% <ø> (ø)

... and 3 files with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages Portal Involves changes to the Portal (docs) codebase.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant