Skip to content

Add Insight Usage Docs for LLMs & Agents #5880

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

Closed
wants to merge 4 commits into from
Closed

Conversation

ianthirdweb
Copy link
Contributor

@ianthirdweb ianthirdweb commented Jan 3, 2025


title: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):

Notes for the reviewer

Anything important to call out? Be sure to also clarify these in your comments.

How to test

Unit tests, playground, etc.


PR-Codex overview

This PR enhances the documentation and functionality of the thirdweb Pay and thirdweb Insight components by adding new sections for onramp providers, preferred providers, and improving API usage examples for agents and LLMs.

Detailed summary

  • Added Onramp Providers section in page.mdx with provider details and links.
  • Introduced Preferred Provider option in PayEmbed and ConnectButton examples.
  • Updated Get Started guide in insight with improved API usage examples.
  • Added For AI Agents & LLMs documentation with API usage instructions.
  • Enhanced API examples for events and token balance retrieval.
  • Improved response structure documentation for clarity.

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

@ianthirdweb ianthirdweb requested review from jakubkrehel and a team as code owners January 3, 2025 16:37
Copy link

changeset-bot bot commented Jan 3, 2025

⚠️ No Changeset found

Latest commit: 6b761aa

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

Copy link

vercel bot commented Jan 3, 2025

You must have Developer access to commit code to thirdweb on Vercel. If you contact an administrator and receive Developer access, commit again to see your changes.

Learn more: https://vercel.com/docs/accounts/team-members-and-roles/access-roles#team-level-roles

Copy link
Contributor

graphite-app bot commented Jan 3, 2025

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.

@github-actions github-actions bot added the Portal Involves changes to the Portal (docs) codebase. label Jan 3, 2025
icon: "thirdweb",
},
title: "thirdweb Pay - Onramp Providers | thirdweb",
description: ".",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The metadata description field contains only a period. Consider replacing it with a descriptive summary that explains the purpose of this page, such as: "Learn about the different onramp providers available in thirdweb Pay and their supported countries"

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

1. **Get All Events**

```typescript
GET / v1 / events;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There appears to be unnecessary whitespace in the API endpoint specification. The correct format should be GET /v1/events without spaces between the path segments.

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

Copy link
Contributor

github-actions bot commented Jan 3, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 45.09 KB (0%) 902 ms (0%) 3.1 s (-20.08% 🔽) 4 s
thirdweb (cjs) 110.84 KB (0%) 2.3 s (0%) 8.4 s (+2.33% 🔺) 10.7 s
thirdweb (minimal + tree-shaking) 5.58 KB (0%) 112 ms (0%) 567 ms (+29.28% 🔺) 678 ms
thirdweb/chains (tree-shaking) 506 B (0%) 10 ms (0%) 211 ms (+245.02% 🔺) 221 ms
thirdweb/react (minimal + tree-shaking) 19.12 KB (0%) 383 ms (0%) 679 ms (-20.66% 🔽) 1.1 s

Copy link

codecov bot commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.19%. Comparing base (a0835f7) to head (d031c3a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5880   +/-   ##
=======================================
  Coverage   55.19%   55.19%           
=======================================
  Files        1123     1123           
  Lines       59622    59622           
  Branches     5029     5029           
=======================================
  Hits        32906    32906           
  Misses      25996    25996           
  Partials      720      720           
Flag Coverage Δ *Carryforward flag
legacy_packages 65.68% <ø> (ø) Carriedforward from 8b1a60d
packages 52.84% <ø> (ø)

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

Copy link

vercel bot commented Jan 3, 2025

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

Name Status Preview Comments Updated (UTC)
docs-v2 ❌ Failed (Inspect) Jan 3, 2025 11:22pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
thirdweb_playground ⬜️ Skipped (Inspect) Jan 3, 2025 11:22pm
thirdweb-www ⬜️ Skipped (Inspect) Jan 3, 2025 11:22pm
wallet-ui ⬜️ Skipped (Inspect) Jan 3, 2025 11:22pm

@vercel vercel bot temporarily deployed to Preview – wallet-ui January 3, 2025 22:45 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground January 3, 2025 22:45 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www January 3, 2025 22:45 Inactive
Copy link
Member

@gregfromstl gregfromstl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this is causing the build to fail

Copy link
Contributor

This PR has been inactive for 7 days. It is now marked as stale and will be closed in 2 days if no further activity occurs.

@github-actions github-actions bot added the Stale label Jan 11, 2025
@github-actions github-actions bot closed this Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Portal Involves changes to the Portal (docs) codebase. Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants