delete outdated webhook docs and move webhooks to tokens#8587
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
github-actions
Bot
added
the
Portal
WalkthroughRemoves the generic Webhooks root page and layout, adds product-scoped webhook docs (Bridge, Tokens), updates Bridge content and imagery, inserts a Tokens Webhooks page and sidebar link, and makes a minor wallets wording tweak. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
⛔ Files ignored due to path filters (2)
📒 Files selected for processing (7)
💤 Files with no reviewable changes (3)
🧰 Additional context used📓 Path-based instructions (3)**/*.{ts,tsx}📄 CodeRabbit inference engine (CLAUDE.md)
Files:
**/*.{js,jsx,ts,tsx,json}📄 CodeRabbit inference engine (AGENTS.md)
Files:
**/*.{ts,tsx,js,jsx}📄 CodeRabbit inference engine (AGENTS.md)
Files:
🪛 LanguageToolapps/portal/src/app/tokens/webhooks/page.mdx[grammar] ~12-~12: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
🔇 Additional comments (6)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
apps/portal/src/app/tokens/webhooks/page.mdx (1)
25-30: Remove excessive blank lines at end of file.The file contains six trailing blank lines. Files should typically end with a single newline for better maintainability.
🔎 Proposed fix
<DocImage src={TokenWebhooksScreen} alt="Token Webhooks Screen" /> - - - - - -
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (2)
apps/portal/src/app/bridge/webhooks/assets/bridge-webhooks.pngis excluded by!**/*.pngapps/portal/src/app/tokens/webhooks/assets/token-webhooks.pngis excluded by!**/*.png
📒 Files selected for processing (7)
apps/portal/src/app/bridge/webhooks/page.mdxapps/portal/src/app/tokens/sidebar.tsxapps/portal/src/app/tokens/webhooks/page.mdxapps/portal/src/app/wallets/security/page.mdxapps/portal/src/app/webhooks/layout.tsxapps/portal/src/app/webhooks/page.mdxapps/portal/src/app/webhooks/sidebar.tsx
💤 Files with no reviewable changes (3)
- apps/portal/src/app/webhooks/layout.tsx
- apps/portal/src/app/webhooks/page.mdx
- apps/portal/src/app/webhooks/sidebar.tsx
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx}: Write idiomatic TypeScript with explicit function declarations and return types
Limit each TypeScript file to one stateless, single-responsibility function for clarity
Re-use shared types from@/typesor localtypes.tsbarrels
Prefer type aliases over interface except for nominal shapes in TypeScript
Avoidanyandunknownin TypeScript unless unavoidable; narrow generics when possible
Choose composition over inheritance; leverage utility types (Partial,Pick, etc.) in TypeScript
**/*.{ts,tsx}: Write idiomatic TypeScript with explicit function declarations and return types
Limit each file to one stateless, single-responsibility function for clarity and testability
Re-use shared types from @/types or local types.ts barrel exports
Prefer type aliases over interface except for nominal shapes
Avoid any and unknown unless unavoidable; narrow generics whenever possible
Choose composition over inheritance; leverage utility types (Partial, Pick, etc.)
Comment only ambiguous logic in TypeScript files; avoid restating TypeScript types and signatures in prose
Files:
apps/portal/src/app/tokens/sidebar.tsx
**/*.{js,jsx,ts,tsx,json}
📄 CodeRabbit inference engine (AGENTS.md)
Biome governs formatting and linting; its rules live in biome.json. Run
pnpm fix&pnpm lintbefore committing, ensure there are no linting errors
Files:
apps/portal/src/app/tokens/sidebar.tsx
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (AGENTS.md)
Lazy-import optional features; avoid top-level side-effects
Files:
apps/portal/src/app/tokens/sidebar.tsx
🪛 LanguageTool
apps/portal/src/app/tokens/webhooks/page.mdx
[grammar] ~12-~12: Ensure spelling is correct
Context: ... Your app may trigger an action when an onchain event occurs, such as: - ETH or an ERC...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: Build Packages
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Lint Packages
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Unit Tests
- GitHub Check: Size
- GitHub Check: Analyze (javascript)
🔇 Additional comments (7)
apps/portal/src/app/wallets/security/page.mdx (1)
199-199: LGTM! Correct grammatical improvement.The hyphenation of "wallets-related" is correct for a compound adjective modifying "features and specs."
Note: This change appears unrelated to the PR's main objective of restructuring webhook documentation, but it's a valid text quality improvement.
apps/portal/src/app/bridge/webhooks/page.mdx (3)
25-36: LGTM! Consistent rebranding from Payments to Bridge Webhooks.The metadata, title, and description are consistently updated to reflect the new "Bridge Webhooks" branding.
38-47: LGTM! Improved dashboard documentation with visual guidance.The restructured dashboard instructions are clearer, and the addition of the DocImage component provides helpful visual context for users.
23-23: The image assetbridge-webhooks.pngexists at the expected location and the import path is correct. No action needed.apps/portal/src/app/tokens/sidebar.tsx (1)
40-43: LGTM! Webhooks link properly added to sidebar.The new Webhooks navigation item is correctly formatted and placed in the Guides section, linking to the corresponding documentation page.
apps/portal/src/app/tokens/webhooks/page.mdx (2)
4-8: LGTM! Clear and informative introduction.The title and introduction effectively communicate the purpose and benefits of token webhooks.
19-23: LGTM! Clear webhook creation instructions.The dashboard navigation instructions are straightforward, and the visual aid enhances user understanding.
size-limit report 📦
|
saminacodes
added
the
merge-queue
Merge activity
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8587 +/- ##
=======================================
Coverage 53.19% 53.19%
=======================================
Files 922 922
Lines 61480 61480
Branches 4032 4032
=======================================
Hits 32706 32706
Misses 28676 28676
Partials 98 98
🚀 New features to boost your workflow:
|
<!--
## title your PR with this format: "[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.
-->
<!-- start pr-codex -->
---
## PR-Codex overview
This PR primarily focuses on the addition and enhancement of webhook documentation for both `Tokens` and `Bridge` functionalities in the application, while removing outdated files.
### Detailed summary
- Deleted files related to `webhooks` in `portal/src/app`.
- Added `webhooks` section in `tokens` documentation with use cases and configuration instructions.
- Updated `bridge` documentation to reflect the correct title and description.
- Enhanced explanations for creating webhooks in both `tokens` and `bridge` contexts.
- Included images for `TokenWebhooksScreen` and `BridgeWebhookScreen`.
> ✨ 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
* **Documentation**
* Reorganized webhooks docs into product-specific guides: Bridge (renamed from Payments Webhooks) and Tokens.
* Added new Token Webhooks guide with use cases, setup steps, and an illustrative image.
* Updated Bridge Webhooks content and dashboard guidance; added visuals and clarified structure and headings.
* Removed the generic Webhooks overview in favor of the new guides.
* Minor wording improvements in Wallets security docs.
<sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
graphite-app
Bot
force-pushed
the
webhooks-docs
branch
from
b8b8ddc to
245e9a6
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/portal/src/app/bridge/webhooks/page.mdx (1)
51-75: Fix variable reference error.Line 67 references
webhookbut the variable is namedpayload(line 60). This will cause aReferenceErrorat runtime.🔎 Proposed fix
const payload = await Bridge.Webhook.parse( body, headers, process.env.WEBHOOK_SECRET // Your webhook secret ); // Process the webhook - console.log("Webhook received:", webhook); + console.log("Webhook received:", payload); return Response.json({ success: true });
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (2)
apps/portal/src/app/bridge/webhooks/assets/bridge-webhooks.pngis excluded by!**/*.pngapps/portal/src/app/tokens/webhooks/assets/token-webhooks.pngis excluded by!**/*.png
📒 Files selected for processing (7)
apps/portal/src/app/bridge/webhooks/page.mdxapps/portal/src/app/tokens/sidebar.tsxapps/portal/src/app/tokens/webhooks/page.mdxapps/portal/src/app/wallets/security/page.mdxapps/portal/src/app/webhooks/layout.tsxapps/portal/src/app/webhooks/page.mdxapps/portal/src/app/webhooks/sidebar.tsx
💤 Files with no reviewable changes (3)
- apps/portal/src/app/webhooks/sidebar.tsx
- apps/portal/src/app/webhooks/page.mdx
- apps/portal/src/app/webhooks/layout.tsx
🧰 Additional context used
📓 Path-based instructions (3)
**/*.{ts,tsx}
📄 CodeRabbit inference engine (CLAUDE.md)
**/*.{ts,tsx}: Write idiomatic TypeScript with explicit function declarations and return types
Limit each TypeScript file to one stateless, single-responsibility function for clarity
Re-use shared types from@/typesor localtypes.tsbarrels
Prefer type aliases over interface except for nominal shapes in TypeScript
Avoidanyandunknownin TypeScript unless unavoidable; narrow generics when possible
Choose composition over inheritance; leverage utility types (Partial,Pick, etc.) in TypeScript
**/*.{ts,tsx}: Write idiomatic TypeScript with explicit function declarations and return types
Limit each file to one stateless, single-responsibility function for clarity and testability
Re-use shared types from @/types or local types.ts barrel exports
Prefer type aliases over interface except for nominal shapes
Avoid any and unknown unless unavoidable; narrow generics whenever possible
Choose composition over inheritance; leverage utility types (Partial, Pick, etc.)
Comment only ambiguous logic in TypeScript files; avoid restating TypeScript types and signatures in prose
Files:
apps/portal/src/app/tokens/sidebar.tsx
**/*.{js,jsx,ts,tsx,json}
📄 CodeRabbit inference engine (AGENTS.md)
Biome governs formatting and linting; its rules live in biome.json. Run
pnpm fix&pnpm lintbefore committing, ensure there are no linting errors
Files:
apps/portal/src/app/tokens/sidebar.tsx
**/*.{ts,tsx,js,jsx}
📄 CodeRabbit inference engine (AGENTS.md)
Lazy-import optional features; avoid top-level side-effects
Files:
apps/portal/src/app/tokens/sidebar.tsx
🪛 LanguageTool
apps/portal/src/app/tokens/webhooks/page.mdx
[grammar] ~12-~12: Ensure spelling is correct
Context: ... Your app may trigger an action when an onchain event occurs, such as: - ETH or an ERC...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Size
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Lint Packages
- GitHub Check: Unit Tests
- GitHub Check: Build Packages
- GitHub Check: Analyze (javascript)
🔇 Additional comments (6)
apps/portal/src/app/wallets/security/page.mdx (1)
199-199: LGTM: Minor grammar improvement.The hyphenation of "wallets-related" is grammatically correct for compound adjectives modifying a noun.
apps/portal/src/app/tokens/sidebar.tsx (1)
40-43: LGTM!The new Webhooks link is properly integrated into the Guides section and follows the existing sidebar structure.
apps/portal/src/app/tokens/webhooks/page.mdx (1)
1-30: LGTM!The documentation is well-structured with clear use cases and instructions for creating token webhooks. The content effectively explains the benefits of webhooks and provides practical examples.
apps/portal/src/app/bridge/webhooks/page.mdx (3)
25-32: LGTM!Metadata properly updated to reflect the Bridge branding consistently across title, image title, and description.
34-45: LGTM!Dashboard instructions are clear and the embedded image provides helpful visual guidance for users creating webhooks.
78-271: LGTM!The verification examples, payload structures, and manual verification code are well-documented and provide comprehensive guidance for webhook implementation.
vercel
Bot
temporarily deployed
to
Production – thirdweb_playground
graphite-app
Bot
removed
the
merge-queue
2 participants
PR-Codex overview
This PR focuses on removing old
webhookspages and assets while adding new content and updates related towebhooksforTokensandBridgefunctionalities, enhancing documentation clarity and organization.Detailed summary
page.mdx,layout.tsx, andsidebar.tsxfiles inapps/portal/src/app/webhooks.apps/portal/src/app/tokens/sidebar.tsxto include a link towebhooks.apps/portal/src/app/wallets/security/page.mdx.webhooksdocumentation inapps/portal/src/app/tokens/webhooks/page.mdx.Bridge Webhookssection inapps/portal/src/app/bridge/webhooks/page.mdx.Bridge Webhooks.Token WebhooksandBridge Webhooks.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.