feat: Cleanup and improve Invoicing use case page #26
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
|
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. WalkthroughRemoved a documentation page and standardized frontmatter across several use-case docs; the Invoicing page was substantially reworked to emphasize API-driven invoicing, update quickstart and demos, rename feature cards, and adjust links and descriptions. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 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🧠 Learnings (1)📚 Learning: 2025-10-30T20:43:28.152ZApplied to files:
🪛 GitHub Check: Mintlify Validation (requestnetwork) - vale-spellcheckuse-cases/invoicing.mdx[warning] 4-4: use-cases/invoicing.mdx#L4 [warning] 9-9: use-cases/invoicing.mdx#L9 [warning] 13-13: use-cases/invoicing.mdx#L13 [warning] 41-41: use-cases/invoicing.mdx#L41 🔇 Additional comments (7)
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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
use-cases/subscriptions.mdx (1)
149-149: Remove the broken card at lines 147-153.The file
api-features/create-requests-query-status.mdxwas confirmed deleted in commit 19d9cbf. The card at lines 147-153 insubscriptions.mdxreferences this deleted file and must be removed before merge. No directly matching alternative exists in the available api-features files.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
api-features/create-requests-query-status.mdx(0 hunks)use-cases/checkout.mdx(1 hunks)use-cases/invoicing.mdx(1 hunks)use-cases/payment-detection.mdx(1 hunks)use-cases/payouts.mdx(1 hunks)use-cases/payroll.mdx(1 hunks)use-cases/subscriptions.mdx(1 hunks)
💤 Files with no reviewable changes (1)
- api-features/create-requests-query-status.mdx
🧰 Additional context used
🪛 GitHub Check: Mintlify Validation (requestnetwork) - vale-spellcheck
use-cases/invoicing.mdx
[warning] 4-4: use-cases/invoicing.mdx#L4
Did you really mean 'crypto'?
[warning] 9-9: use-cases/invoicing.mdx#L9
Did you really mean 'crypto'?
[warning] 13-13: use-cases/invoicing.mdx#L13
Did you really mean 'crypto'?
[warning] 41-41: use-cases/invoicing.mdx#L41
Did you really mean 'crypto'?
⏰ 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). (1)
- GitHub Check: Agent
🔇 Additional comments (12)
use-cases/payouts.mdx (1)
2-3: Metadata update is consistent with broader icon standardization.The frontmatter changes (emoji removal and icon addition) align with the PR objective to standardize use-case page metadata. No issues detected.
use-cases/checkout.mdx (1)
2-3: Metadata standardization applied correctly.Icon and title changes follow the same pattern as other use-case pages. No issues detected.
use-cases/payment-detection.mdx (1)
2-3: Metadata update follows standardization pattern.Icon and title changes are consistent with other use-case page updates. No issues detected.
use-cases/payroll.mdx (1)
2-3: Metadata standardization applied consistently.Icon and title changes match the broader use-case page update pattern. No issues detected.
use-cases/subscriptions.mdx (1)
2-3: Metadata update follows standardization pattern.Icon and title changes are consistent with other use-case pages. No issues with these changes.
use-cases/invoicing.mdx (7)
2-5: Metadata update and description are appropriate.Title emoji removal and icon addition align with standardization across use-case pages. Description update emphasizing API-driven workflow is clear and accurate.
7-16: Overview rewrite is well-focused and benefits-driven.The new overview effectively communicates value propositions (permanent records, multi-currency flexibility, instant reconciliation, cross-chain support, webhook automation) with specific, quantifiable claims ("9 EVM chains and 150+ currencies"). Removal of AI-generated warning is appropriate.
18-30: Quickstart restructuring improves clarity with API-centric steps.The streamlined three-step flow (Create Invoice → Process Payment → Track Payment) with direct links to API endpoints is more actionable than before. Links to
/api-reference/request/create-requestand/api-features/webhooks-eventsshould be verified for validity.
52-105: Integration Approaches restructuring improves UX with card layout and comparison link.The layout change from tabs to a 2-column card grid + full-width card (lines 56–105) enhances discoverability. The new Info callout (lines 52–54) directing users to a detailed integration comparison is helpful. Links to
/api-features/create-requestsand placeholder links (#) are intentional per PR objectives.
177-201: What's Next section appropriately reorganized with updated links.Cards now point to:
/api-setup/getting-started(line 180)- Placeholder link
#for code examples (line 188, intentional per PR objectives)/resources/supported-chains-and-currencies(line 196)All non-placeholder links should be verified. The placeholder at line 188 is intentional per PR objectives ("Left some links as placeholders (#) until future pages are created").
4-4: Static analysis spell-check warnings on "crypto" are false positives.The Mintlify validation tool flags "crypto" as potentially misspelled on lines 4, 9, 13, and 41. However, "crypto" is correct and standard terminology in the context of cryptocurrency/blockchain documentation. These warnings can be safely ignored or the spell-checker configuration can be updated to allow this term.
Also applies to: 9-9, 13-13, 41-41
32-48: Inconsistent demo URLs verified across use-case pages.The URL discrepancy identified in the review comment is confirmed:
- invoicing.mdx (lines 38, 60, 70):
https://easyinvoice.request.network- checkout.mdx (line 52):
https://easy-invoice-demo.vercel.app/pay- payouts.mdx (line 60):
https://easy-invoice-demo.vercel.app/payouts- payroll.mdx (line 53):
https://easy-invoice-demo.vercel.app/payouts/batch- subscriptions.mdx (line 52):
https://easy-invoice-demo.vercel.app/dashboard/subscriptionsVerify which URL is the canonical endpoint for your use case (easyinvoice.request.network vs. easy-invoice-demo.vercel.app), then update all pages consistently per the PR's "Fixed EasyInvoice URL" objective.
There was a problem hiding this comment.
Pull request overview
This PR modernizes the Invoicing use case documentation page by removing AI-generated warnings, marketing language, and placeholder content while establishing a consistent documentation pattern across all use case pages. The main changes replace emoji titles with proper icon properties, restructure the Integration Approaches section into a clearer card-based layout, expand the Key API Features section from 4 to 8 features with proper navigation links, and clean up the quickstart flow.
Key changes:
- Replaced emoji-based titles with Font Awesome icons across 6 use case pages (invoicing, subscriptions, payroll, payouts, payment-detection, checkout)
- Restructured invoicing.mdx with benefits-focused copy, expanded API features coverage, and improved integration approach presentation
- Removed deprecated
api-features/create-requests-query-status.mdxfile
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| use-cases/invoicing.mdx | Complete rewrite removing AI warnings and marketing fluff; restructured with 3-tier integration approach, 8 API features, and updated to reference 9 EVM chains |
| use-cases/subscriptions.mdx | Removed emoji from title, added icon property to frontmatter |
| use-cases/payroll.mdx | Removed emoji from title, added icon property to frontmatter |
| use-cases/payouts.mdx | Removed emoji from title, added icon property to frontmatter |
| use-cases/payment-detection.mdx | Removed emoji from title, added icon property to frontmatter |
| use-cases/checkout.mdx | Removed emoji from title, added icon property to frontmatter |
| api-features/create-requests-query-status.mdx | Deleted deprecated file (content split into separate focused pages) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MantisClone
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
use-cases/invoicing.mdx (2)
18-30: Resolve unresolved past review issue: incorrect API reference link.Line 22 still references
/api-reference/request/create-request, which was flagged in a past review as incorrect. This link path is inconsistent with the API feature structure elsewhere in the file (see line 112).Apply this diff to correct the API reference link:
<Step title="Create Invoice"> - Call the [Create Request endpoint](/api-reference/request/create-request) with invoice details + Call the [Create Request endpoint](/api-features/create-requests) with invoice details </Step>
50-88: Change the integration approaches link to a placeholder until the page is created.Line 53 references
/resources/integration-approaches, which does not exist in theresources/directory. Align with the pattern used elsewhere in this file by changing the link to#.- [See our detailed comparison of integration approaches →](/resources/integration-approaches) + [See our detailed comparison of integration approaches →](#)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
use-cases/invoicing.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-30T20:43:28.152Z
Learnt from: MantisClone
Repo: RequestNetwork/mintlify-docs PR: 2
File: docs.json:114-114
Timestamp: 2025-10-30T20:43:28.152Z
Learning: The Request Network production OpenAPI specification is located at https://api.request.network/open-api/openapi.json (with hyphen in "open-api"), not at /openapi.json.
Applied to files:
use-cases/invoicing.mdx
🪛 GitHub Check: Mintlify Validation (requestnetwork) - vale-spellcheck
use-cases/invoicing.mdx
[warning] 4-4: use-cases/invoicing.mdx#L4
Did you really mean 'crypto'?
[warning] 9-9: use-cases/invoicing.mdx#L9
Did you really mean 'crypto'?
[warning] 13-13: use-cases/invoicing.mdx#L13
Did you really mean 'crypto'?
[warning] 41-41: use-cases/invoicing.mdx#L41
Did you really mean 'crypto'?
🔇 Additional comments (3)
use-cases/invoicing.mdx (3)
1-16: Frontmatter and overview section looks good.Icon properly replaces emoji, chain count correctly updated to 9 (Fantom deprecation), and content reframed to emphasize benefits. Note: the static analysis warnings about "crypto" are false positives—this is the correct technical terminology.
32-48: Demo section well-structured.The EasyInvoice URL is correctly updated, and the "What you'll see" list sets clear expectations for users. Good practice.
159-185: Placeholder links are consistent with PR intent.Lines 172 ("View Invoicing Examples" →
#) uses a placeholder link in alignment with the PR's deferred-content strategy. Other links in this section correctly reference valid resources.
MantisClone
left a comment
MantisClone
left a comment
There was a problem hiding this comment.
All issues addressed:
- Fixed indentation on Build with API card
- Fixed Create Request endpoint link path
- Updated Recurring Invoices link to existing page
- Kept Integration Approaches link as intentional placeholder (Issue #27 created)
|
@MantisClone I've opened a new pull request, #30, to work on those changes. Once the pull request is ready, I'll request review from you. |
|
@MantisClone I've opened a new pull request, #31, to work on those changes. Once the pull request is ready, I'll request review from you. |
- 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
Problem
The Invoicing use case page contained AI-generated warnings, marketing fluff, incorrect URLs, placeholder links, emoji titles, and suboptimal layout that undermined credibility and user experience.
Proposed Solution
Complete cleanup and restructuring of the page:
Considerations
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.
✏️ Tip: You can customize this high-level summary in your review settings.