Skip to content

New engine docs #6951

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 19 commits into from
May 7, 2025
Merged

New engine docs #6951

merged 19 commits into from
May 7, 2025

Conversation

@saminacodes
Copy link
Member

@saminacodes saminacodes commented May 6, 2025 •
edited by pr-codex bot
Loading

CORE-0000

PR-Codex overview

This PR focuses on updating the documentation and features for the thirdweb Engine, including the introduction of Vault, enhancements to wallet management, and improvements to the overall user experience with new guides and FAQs.

Detailed summary

  • Removed outdated .mdx files.
  • Added new Vault documentation with features and FAQs.
  • Updated existing guides to reflect changes in wallet configurations.
  • Enhanced sidebar navigation for Engine and Vault.
  • Introduced Engine Version Selector for easier version management.
  • Updated references to backend wallets and access tokens throughout the documentation.

The following files were skipped due to too many changes: apps/portal/src/app/engine/v3/page.mdx, apps/portal/src/app/engine/v2/page.mdx, apps/portal/src/app/engine/self-host/page.mdx, apps/portal/src/app/vault/key-concepts/key-management/page.mdx, apps/portal/src/app/vault/security/page.mdx, apps/portal/src/app/engine/v3/get-started/page.mdx

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

@saminacodes saminacodes requested review from a team as code owners May 6, 2025 00:26
@changeset-bot
Copy link

changeset-bot bot commented May 6, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 40d16ac

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

@vercel
Copy link

vercel bot commented May 6, 2025 •
edited
Loading

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 7, 2025 8:31pm
login ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 7, 2025 8:31pm
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 7, 2025 8:31pm
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 7, 2025 8:31pm
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 7, 2025 8:31pm

@graphite-app
Copy link
Contributor

graphite-app bot commented May 6, 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 May 6, 2025
graphite-app[bot]
graphite-app bot reviewed May 6, 2025
View reviewed changes
@codecov
Copy link

codecov bot commented May 6, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.02%. Comparing base (ec50f8c) to head (f392aed).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #6951   +/-   ##
=======================================
  Coverage   55.02%   55.02%           
=======================================
  Files         898      898           
  Lines       57352    57352           
  Branches     3969     3969           
=======================================
  Hits        31560    31560           
  Misses      25692    25692           
  Partials      100      100
Flag Coverage Δ
packages 55.02% <ø> (ø)
🚀 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.

@github-actions
Copy link
Contributor

github-actions bot commented May 6, 2025 •
edited
Loading

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 53.77 KB (0%) 1.1 s (0%) 296 ms (+120.95% 🔺) 1.4 s
thirdweb (cjs) 144.21 KB (0%) 2.9 s (0%) 489 ms (+33.69% 🔺) 3.4 s
thirdweb (minimal + tree-shaking) 5.68 KB (0%) 114 ms (0%) 111 ms (+672.77% 🔺) 225 ms
thirdweb/chains (tree-shaking) 524 B (0%) 11 ms (0%) 38 ms (+652.31% 🔺) 48 ms
thirdweb/react (minimal + tree-shaking) 19.48 KB (0%) 390 ms (0%) 116 ms (+298.21% 🔺) 505 ms

@saminacodes @graphite-app
Update apps/portal/src/app/vault/security/page.mdx
834ae03 
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
Signed-off-by: samina <[email protected]>
@vercel vercel bot temporarily deployed to Preview – login May 6, 2025 00:31 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 6, 2025 00:31 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www May 6, 2025 00:31 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 6, 2025 00:31 Inactive
@saminacodes @graphite-app
Update apps/portal/src/app/engine/faq/page.mdx
3ceb449 
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
Signed-off-by: samina <[email protected]>
@vercel vercel bot temporarily deployed to Preview – thirdweb-www May 6, 2025 00:32 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 6, 2025 00:32 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 6, 2025 00:32 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 6, 2025 00:32 Inactive
graphite-app[bot]
graphite-app bot reviewed May 6, 2025
View reviewed changes
graphite-app[bot]
graphite-app bot reviewed May 6, 2025
View reviewed changes
@saminacodes @graphite-app
Update apps/portal/src/app/engine/configure-wallets/page.mdx
3a0cd99 
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
Signed-off-by: samina <[email protected]>
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 6, 2025 00:37 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 6, 2025 00:37 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www May 6, 2025 00:37 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www May 6, 2025 16:01 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 6, 2025 16:10 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www May 6, 2025 16:10 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 6, 2025 16:10 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 6, 2025 16:10 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 6, 2025 16:30 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 6, 2025 16:30 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 6, 2025 16:30 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www May 6, 2025 16:30 Inactive
graphite-app[bot]
graphite-app bot reviewed May 7, 2025
View reviewed changes
apps/portal/src/app/vault/key-concepts/accounts/page.mdx
1. **Admin Key**: Grants access to every operation on every entity owned by the account
2. **Rotation Code**: Used to invalidate current credentials and generate new ones during security events

Service Accounts can used in combination with access-tokens to build non-custodial programmable access control for your enterprise applications. No newline at end of file
Copy link
Contributor

@graphite-app graphite-app bot May 7, 2025

Choose a reason for hiding this comment

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

There's a minor grammatical error in this sentence. It should read "Service Accounts can be used" rather than "Service Accounts can used" to maintain proper verb tense structure.

Suggested change
Service Accounts can used in combination with access-tokens to build non-custodial programmable access control for your enterprise applications.
Service Accounts can be used in combination with access-tokens to build non-custodial programmable access control for your enterprise applications.

Spotted by Diamond

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

@joaquim-verges joaquim-verges merged commit 4c5fc83 into main May 7, 2025
19 of 20 checks passed
@joaquim-verges joaquim-verges deleted the new-engine-docs branch May 7, 2025 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@graphite-app graphite-app[bot] graphite-app[bot] left review comments

Assignees

@saminacodes saminacodes

Labels

Portal Involves changes to the Portal (docs) codebase.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@saminacodes @joaquim-verges