[Docs] webhook and ub docs #7278
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
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. |
WalkthroughThe updates include renaming a sidebar link from "Getting Started" to "Get Started" under the Webhooks section, expanding and improving the Insight Webhooks documentation with detailed step-by-step instructions and images, adding a new "Troubleshoot" sidebar link and page under Pay, and updating related metadata and imports. Changes
Suggested labels
Suggested reviewers
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
⏰ Context from checks skipped due to timeout of 90000ms (4)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
the
Portal
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7278 +/- ##
=======================================
Coverage 55.57% 55.57%
=======================================
Files 909 909
Lines 58667 58667
Branches 4158 4158
=======================================
Hits 32606 32606
Misses 25954 25954
Partials 107 107
🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
apps/portal/src/app/insight/sidebar.tsx (1)
68-69: Consider adding an in-page anchor
The "Get Started" link currently points to/insight/webhooks. To scroll directly to the corresponding section on the page, consider appending the fragment identifier (e.g.,#/get-started) or confirm that the default navigation behavior aligns with the intended UX.apps/portal/src/app/pay/troubleshoot/page.mdx (1)
10-10: Fix verb usage: "work around"
Use the verb phrase "work around" (two words) and include the article before "debit card":- To workaround this issue, you can try using a different card or payment method, such as debit card, if available. + To work around this issue, you can try using a different card or payment method, such as a debit card, if available.🧰 Tools
🪛 LanguageTool
[grammar] ~10-~10: The word “workaround” is a noun. The verb is spelled with a white space.
Context: ...not allow cryptocurrency purchases. To workaround this issue, you can try using a differe...(NOUN_VERB_CONFUSION)
apps/portal/src/app/insight/webhooks/page.mdx (1)
34-34: Capitalize heading for consistency
The new section header reads "## Get started". To align with the sidebar label and maintain consistency, update it to "## Get Started":- ## Get started + ## Get Started
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
apps/portal/src/app/insight/webhooks/assets/create-filters.pngis excluded by!**/*.pngapps/portal/src/app/insight/webhooks/assets/create-webhooks.pngis excluded by!**/*.pngapps/portal/src/app/insight/webhooks/assets/test-webhook.pngis excluded by!**/*.png
📒 Files selected for processing (4)
apps/portal/src/app/insight/sidebar.tsx(1 hunks)apps/portal/src/app/insight/webhooks/page.mdx(2 hunks)apps/portal/src/app/pay/sidebar.tsx(2 hunks)apps/portal/src/app/pay/troubleshoot/page.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/portal/src/app/pay/troubleshoot/page.mdx
[grammar] ~10-~10: The word “workaround” is a noun. The verb is spelled with a white space.
Context: ...not allow cryptocurrency purchases. To workaround this issue, you can try using a differe...
(NOUN_VERB_CONFUSION)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: codecov/patch
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Build Packages
- GitHub Check: Unit Tests
- GitHub Check: Lint Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (5)
apps/portal/src/app/insight/sidebar.tsx (1)
68-69: Sidebar label rename approved
The nested link under the "Webhooks" section has been correctly renamed from "Getting Started" to "Get Started" to match the updated documentation.apps/portal/src/app/pay/sidebar.tsx (2)
14-14: Import forWrenchIconis correct
TheWrenchIconhas been added to the lucide-react imports to support the new "Troubleshoot" entry.
120-124: Add "Troubleshoot" sidebar entry
The new "Troubleshoot" link under the Universal Bridge section is correctly configured with the proper path (/pay/troubleshoot) and icon (<WrenchIcon />).apps/portal/src/app/pay/troubleshoot/page.mdx (1)
1-9: Skip trivial new content
The import, page title,<Details>summary, and introductory paragraphs are clear and follow existing patterns.apps/portal/src/app/insight/webhooks/page.mdx (1)
1-4: Skip imports, metadata, and guarantees update
ThecreateMetadatacall, image imports, updated description, and revised "Delivery Guarantees" paragraph are well-structured and require no changes.Also applies to: 8-8, 27-33
size-limit report 📦
|
saminacodes
added
the
merge-queue
Merge activity
|
CORE-0000
<!-- start pr-codex -->
---
## PR-Codex overview
This PR focuses on enhancing the user experience for webhooks in the thirdweb platform by updating sidebar navigation, adding troubleshooting information, and improving documentation on configuring webhooks.
### Detailed summary
- Updated sidebar in `insight` to rename "Getting Started" to "Get Started".
- Added "Troubleshoot" section with `WrenchIcon` in `pay` sidebar.
- Introduced troubleshooting content in `troubleshoot/page.mdx`.
- Enhanced `webhooks/page.mdx` with new structure and images for configuration steps.
- Revised descriptions and added a "Get started" section in `webhooks/page.mdx`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai -->
## Summary by CodeRabbit
- **New Features**
- Added a "Troubleshoot" section in the sidebar for Universal Bridge, providing guidance for resolving payment card issues.
- Introduced a troubleshooting article explaining card support errors and suggesting alternative payment methods.
- **Documentation**
- Enhanced the Insight Webhooks documentation with step-by-step setup instructions, visual aids, and improved metadata description.
- Added a new "Get started" section to guide users through webhook creation and testing.
- **Style**
- Renamed the "Getting Started" sidebar link under Webhooks to "Get Started" for consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
graphite-app
bot
force-pushed
the
ub-and-webhooks
branch
from
de3136d to
9493fda
Compare
graphite-app
bot
removed
the
merge-queue
CORE-0000
PR-Codex overview
This PR focuses on updating the sidebar navigation and documentation for webhooks in the
insightandpaysections, enhancing user guidance and adding troubleshooting information.Detailed summary
paysidebar with aWrenchIcon.page.mdxfor payment issues.insight/webhooks/page.mdx:Summary by CodeRabbit
New Features
Documentation
Style