-
Notifications
You must be signed in to change notification settings - Fork 0
docs: clean up Payment Detection use case page #32
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
Conversation
- Remove AI-generated warning - Improve overview with benefits-focused copy - Fix quickstart steps (payment processing clarity) - Update demo section with correct EasyInvoice URL - Convert integration approaches from tabs to card layout - Add Info callout linking to integration comparison - Update Key API Features (8 features, proper links, reordered) - Improve What's Next section (3 focused cards) - Replace emojis with proper icons in title - Fix all em-dashes to normal dashes - Add missing features: Query Requests, Payment Types Overview - Update all other use case pages to use icons instead of emojis
- Remove AI-generated content warning - Update chain count from '10+ EVM chains' to accurate '9 EVM chains' - Update currency count to '150+ currencies' for consistency - Rewrite Overview to lead with problem/solution (crypto payments lack context) - Add tooltips for technical terms (transaction hash, blockchain, webhook, confirmations) - Update 'When to Use' cards with accurate counts and clearer copy - Refine 'Common Scenarios' with minor improvements and tooltip - Add Info callout linking to technical details (replaces deleted section) - Update 'How Payment Detection Works' steps with tooltips - Add Info callout explaining Payment Detection powers all use cases - Remove 'Detection Features' section (technical details belong in API feature page) - Remove 'Detection-Only vs Full Workflows' Tabs (confusing framing) - Remove 'Implementation Example' code section (belongs in API Reference) - Remove 'Supported Networks & Currencies' section (have dedicated page) - Rename 'API Integration' to 'Key API Features for Payment Detection' - Reorder and update API feature cards for clarity - Update 'Next Steps' to 'What's Next?' with 3 focused cards - Link to welcome page demo showing payment collision prevention - Reduce page from ~310 lines to ~180 lines (42% reduction) Follows template from Invoicing page cleanup (PR #26) References Issue #29 and parent Issue #18
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughThe Payment Detection use-case documentation page is substantially restructured to emphasize business-context workflows, request-based attribution, and multi-chain monitoring. Overview, step sequences, and section organization are rewritten; marketing language is replaced with factual benefits; speculative and AI-generated content is removed; and new sections consolidate cross-use-case references and API features. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 GitHub Check: Mintlify Validation (requestnetwork-docs-cleanup-invoicing-use-case) - vale-spellcheckuse-cases/payment-detection.mdx[warning] 9-9: use-cases/payment-detection.mdx#L9 [warning] 29-29: use-cases/payment-detection.mdx#L29 [warning] 37-37: use-cases/payment-detection.mdx#L37 [warning] 44-44: use-cases/payment-detection.mdx#L44 [warning] 46-46: use-cases/payment-detection.mdx#L46 [warning] 49-49: use-cases/payment-detection.mdx#L49 [warning] 53-53: use-cases/payment-detection.mdx#L53 [warning] 54-54: use-cases/payment-detection.mdx#L54 [warning] 56-56: use-cases/payment-detection.mdx#L56 [warning] 56-56: use-cases/payment-detection.mdx#L56 🔇 Additional comments (5)
Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR refactors the Payment Detection use case page by removing AI-generated content warnings, streamlining structure, and improving clarity. The page is reduced from ~310 lines to ~180 lines (42% reduction) by eliminating duplicated technical content that belongs in API feature documentation.
Key changes:
- Rewrites Overview section to lead with problem/solution format emphasizing Request ID context
- Adds tooltips for technical terms (transaction hash, blockchain, webhooks, confirmations)
- Removes duplicated sections (Detection Features, code examples, network lists) in favor of links to API documentation
- Adds Info callouts explaining that Payment Detection powers all Request Network use cases
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Reduce from 5 steps to 4 steps focused on user journey - Remove technical implementation details (verification, confirmations, reconciliation logic) - Make steps more actionable and less technical - Update Info callout to explicitly link to technical details in API Features page - Leave complex explanations for dedicated API Features page
- Update Overview to explain reference-based payment detection - Clarify that 16-character payment reference is included in transactions, not Request ID - Update 'How Payment Detection Works' steps to reflect actual technical flow - Update all examples to use 'payment reference' terminology consistently - Maintain simplified language while being technically accurate Based on official docs: https://docs.request.network/request-network-api/payment-detection.md
Strategy: Use Case page uses user-facing 'Request ID' abstraction, API Features page will explain 'Payment Reference' implementation details. Changes: - Overview: Request IDs attach business context (not payment references) - Steps: Request ID is automatically embedded (abstracts payment reference mechanism) - Examples: All use 'Request ID' consistently - Maintains consistency with Welcome page vocabulary - Links to API Features page for technical deep dive Terminology strategy: - Request ID = user-facing identifier users interact with - Payment Reference = 16-char derived identifier for smart contracts - API Features page will explain the derivation and correlation - Use Case page focuses on what/why, not how This maintains technical accuracy while providing appropriate abstraction level for use case documentation.
- Replace 'embedded' with 'included in the transaction' (more precise, commonly used term) - Change 'request status updates and you receive webhook' to 'you receive webhook with payment details' - Avoids claiming request state changes (technically inaccurate - IPFS stores request state, payments detected via subgraphs, status derived from combining both) - Focuses on what user experiences (webhook notification) rather than internal state management
- Change 'included in the transaction' to 'connected to the transaction' - Fix tooltip formatting: move comma inside tooltip for 'transaction hash' - 'Connected' is more accurate and user-friendly than 'included'
- Reorder to prioritize e-commerce checkout (canonical use case) - Remove donations scenario (too niche) - Strengthen remaining scenarios with clearer value props New order: 1. E-commerce Checkout - high-volume, single wallet, many customers 2. SaaS Subscriptions - recurring payments, automatic renewals 3. Manual Invoices - integration with existing workflows, variable amounts Each scenario now emphasizes distinct value proposition and use case pattern.
Replace generic benefits with specific problem indicators: 1. Payment Collisions - Core technical problem (connects to welcome demo) 2. High Payment Volume - Scale problem where manual tracking fails 3. Wallet Management Overhead - Operational pain of separate wallets 4. Cross-chain Payments - Unified detection across chains without multiple APIs Each card now helps users self-identify if they have problems Payment Detection solves, rather than listing generic benefits.
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
Problem
Payment Detection use case page had AI warnings, inaccurate claims, and duplicated content across sections.
Proposed Solution
Applied Invoicing page cleanup template with additional refinements:
Content accuracy:
Section improvements:
Removed sections:
Additions:
Results:
Considerations
Closes #29
Part of #18
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.