docs: add AI-generated content warnings and reorganize v2 migration page #16
Conversation
|
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. WalkthroughAdds AI-generated-content warning blocks to many MDX docs, updates Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Comment |
There was a problem hiding this comment.
Pull Request Overview
This PR adds AI-generated content warnings across documentation pages, reorganizes navigation structure, and introduces a migration guide for transitioning from API V1 to V2. The changes aim to improve transparency about AI-generated content and provide better guidance for API version migration.
Key changes:
- Added AI-generated content warning banners to 25+ documentation pages
- Created new migration guide at
api-setup/migrate-to-v2.mdxwith comprehensive V1 to V2 transition information - Moved migration guide from SDK section to API Setup section in navigation
- Added new SDK overview page at
sdk-legacy/overview.mdx - Updated banner text from "Landing page" to "Welcome page"
Reviewed Changes
Copilot reviewed 37 out of 38 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| use-cases/*.mdx | Added AI-generated content warnings and updated descriptions for subscription, payroll, payout, checkout, invoicing, and payment detection pages |
| resources/*.mdx | Added AI-generated content warnings to community, lifecycle, request-scan, token-list, and supported-chains documentation |
| request-network-api/*.mdx | Added AI-generated content warnings to API demo and portal documentation |
| release-notes/*.mdx | Added AI-generated content warnings to release notes pages |
| api-setup/.mdx, api-features/.mdx, api-reference/*.mdx | Added AI-generated content warnings to API setup, features, and reference pages |
| glossary.mdx, faq.mdx | Added AI-generated content warnings |
| sdk-legacy/overview.mdx | New SDK overview page with API vs SDK comparison and migration guidance |
| api-setup/migrate-to-v2.mdx | New comprehensive migration guide from V1 to V2 API |
| docs.json | Updated navigation structure and banner text |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (37)
api-features/batch-payments.mdx(1 hunks)api-features/conversion-payments.mdx(1 hunks)api-features/create-requests.mdx(1 hunks)api-features/crosschain-payments.mdx(1 hunks)api-features/crypto-to-fiat-payments.mdx(1 hunks)api-features/fee-breakdowns.mdx(1 hunks)api-features/partial-payments.mdx(1 hunks)api-features/payment-detection.mdx(1 hunks)api-features/payment-types-overview.mdx(1 hunks)api-features/platform-fees.mdx(1 hunks)api-features/query-payments.mdx(1 hunks)api-features/query-requests.mdx(1 hunks)api-features/recurring-payments.mdx(1 hunks)api-features/standard-payments.mdx(1 hunks)api-reference/authentication.mdx(1 hunks)api-setup/getting-started.mdx(1 hunks)docs.json(3 hunks)faq.mdx(1 hunks)glossary.mdx(1 hunks)release-notes/easy-invoice.mdx(1 hunks)release-notes/index.mdx(1 hunks)release-notes/request-api.mdx(1 hunks)request-network-api/api-portal-manage-api-keys-and-webhooks.mdx(1 hunks)request-network-api/create-and-pay-requests.mdx(1 hunks)request-network-api/easyinvoice-api-demo-app.mdx(1 hunks)resources/community.mdx(1 hunks)resources/lifecycle-of-a-request.mdx(1 hunks)resources/request-scan.mdx(1 hunks)resources/supported-chains-and-currencies.mdx(1 hunks)resources/token-list.mdx(1 hunks)sdk-legacy/overview.mdx(1 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)
🧰 Additional context used
🧠 Learnings (3)
📚 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:
release-notes/request-api.mdxresources/community.mdxresources/token-list.mdxrequest-network-api/create-and-pay-requests.mdx
📚 Learning: 2025-10-30T20:08:18.627Z
Learnt from: MantisClone
Repo: RequestNetwork/mintlify-docs PR: 2
File: api-features/crosschain-payments.mdx:2-2
Timestamp: 2025-10-30T20:08:18.627Z
Learning: Request Network documentation uses hyphen-less variants for blockchain terminology: "onchain", "offchain", "crosschain", and "samechain" (not "on-chain", "off-chain", "cross-chain", "same-chain").
Applied to files:
faq.mdxresources/supported-chains-and-currencies.mdxapi-features/crosschain-payments.mdx
📚 Learning: 2025-10-31T19:30:28.106Z
Learnt from: MantisClone
Repo: RequestNetwork/mintlify-docs PR: 3
File: general/request-network-token-list.mdx:23-33
Timestamp: 2025-10-31T19:30:28.106Z
Learning: In the Request Network token list, token IDs follow different formats: ERC20 tokens use `symbol-chain` format (e.g., `USDC-mainnet`, `FRAX-mainnet`), native tokens use `symbol-chain-chain` format (e.g., `ETH-mainnet-mainnet`), and fiat currencies use just the symbol (e.g., `USD`, `EUR`).
Applied to files:
resources/token-list.mdxresources/supported-chains-and-currencies.mdxapi-features/standard-payments.mdx
🔇 Additional comments (48)
use-cases/payment-detection.mdx (1)
6-8: AI-generated content warning appropriately added.The warning is well-placed after the frontmatter and before the content, with a balanced message that acknowledges AI assistance while maintaining reader confidence. The links provide clear next steps for verification. This follows the documented pattern across the PR.
For completeness, please verify the links are correct:
https://docs.request.networkshould resolve to your stable documentation- The GitHub discussions link references the correct organization (
RequestNetwork)These are low-priority checks; the implementation itself is solid.
use-cases/payroll.mdx (2)
2-3: ✓ Title and description updates are clear and marketing-focused.The emoji change from briefcase to building better represents a payroll/company context. The description is more concise and explicitly highlights the crypto-native aspect ("in crypto"), which provides better clarity to users about the Request Network value proposition.
6-8: ✓ AI-generated content warning is correctly positioned and formatted.The warning block is properly placed after the frontmatter, follows the established MDX pattern across the PR, and includes appropriate disclaimers with links to stable documentation and support channels. The tone balances transparency about AI generation with confidence in accuracy.
use-cases/payouts.mdx (2)
3-3: Verify the description change aligns with PR objectives.The description was significantly rewritten from marketing-focused language to technical language. While the PR mentions "updates descriptions/titles," please verify this change was intentional and doesn't represent an unintended side effect (e.g., merge conflict resolution).
Original: "Send instant crypto payouts to vendors, contractors, and partners with full transparency"
Current: "Send batch payments to multiple recipients with automatic tracking and reconciliation"
6-8: AI warning block placement and content look good.The warning callout is properly formatted and aligns with the PR objective to add AI-generated content disclaimers to pages. The message strikes a balance between transparency and confidence, and includes links to stable docs and support.
resources/lifecycle-of-a-request.mdx (1)
6-8: Consistent AI-generated content warning implementation. ✓The warning block is properly formatted, clearly communicates the content status, and provides actionable next steps for verification. The placement after the front matter and before main content is appropriate and maintains readability.
request-network-api/api-portal-manage-api-keys-and-webhooks.mdx (1)
6-8: Well-placed warning callout with clear verification guidance. ✓The warning maintains visual prominence without disrupting the page flow. The webhook signature verification code sample (lines 48–58) appropriately uses
crypto.timingSafeEqualto prevent timing attacks.api-features/batch-payments.mdx (1)
6-8: AI-generated warning follows established pattern. ✓The warning is consistently placed and formatted. The Mermaid diagram and use-case links complement the warning by providing a clear visual summary and reference to stable documentation alternatives.
release-notes/request-api.mdx (1)
6-8: Appropriate warning for release notes documentation. ✓Placing the warning before version history is sensible, especially since release notes are often auto-generated or AI-assisted. The provided links to stable docs and support channels offer clear escalation paths.
Verify that the external links in the warning block (
https://docs.request.networkand GitHub discussions) remain stable and accessible as users navigate from these updated pages.use-cases/checkout.mdx (1)
3-3: Enhanced description and warning placement are well-integrated. ✓The updated description (line 3) provides better clarity about the checkout use case and integrates naturally with the new warning block. The page maintains strong technical content with concrete code examples (React component, webhook handler) that users can trust and verify independently.
Also applies to: 6-8
release-notes/easy-invoice.mdx (1)
6-8: Warning callout appropriately positioned in release notes. ✓The warning provides transparency about AI-assisted content generation while maintaining a positive tone with "likely close to accurate." The structured release history with versioned Update components allows readers to drill down into specific details.
api-features/crypto-to-fiat-payments.mdx (1)
6-8: Clear warning placement before compliance-sensitive content. ✓For pages covering KYC and regulatory requirements (as this page does), the AI-generated warning is especially valuable—it prompts users to verify compliance details against stable documentation or support channels before implementation.
api-features/standard-payments.mdx (1)
6-8: Consistent implementation across all feature documentation. ✓The warning block maintains parity with other feature pages in the api-features directory, providing users with a uniform, transparent messaging strategy. Clear delineation between native and ERC20 payment types strengthens the underlying content quality.
api-features/payment-detection.mdx (1)
6-8: Warning block properly positioned and formatted.The AI-generated content warning is appropriately placed after the frontmatter and before the main content. Messaging is clear and balanced, acknowledging AI generation while providing paths to verification.
api-features/platform-fees.mdx (1)
6-8: Warning block consistent with other pages in the PR.Placement and messaging align with the documentation-wide pattern established for AI-generated content transparency.
api-features/query-requests.mdx (1)
6-8: Warning block properly integrated.The addition maintains consistency with peer documentation pages updated in this PR.
api-features/crosschain-payments.mdx (1)
6-8: Warning block placement is correct.Addition maintains consistency across all updated pages in this PR. Terminology ("crosschain" without hyphen) aligns with Request Network documentation standards.
resources/token-list.mdx (1)
7-9: Warning block appropriately placed.Addition follows the established pattern for this PR without affecting the token list reference content.
faq.mdx (1)
7-9: Warning block integration is consistent.Placement between frontmatter and informational content is appropriate. Message provides clear disclosure of AI-generated content with verification paths.
resources/supported-chains-and-currencies.mdx (1)
6-8: Warning block positioned consistently.Addition does not interfere with the comprehensive reference data in this page. Transparency disclosure is clearly visible to readers.
request-network-api/easyinvoice-api-demo-app.mdx (1)
6-8: Warning block consistent with PR-wide pattern.Addition maintains the established transparency approach across all AI-generated documentation.
api-features/partial-payments.mdx (1)
6-8: Warning block implementation approved.Consistent with PR objectives. The AI-generated content notice is properly placed, clearly communicates the need for verification, and links to stable documentation and support.
release-notes/index.mdx (1)
6-8: Warning block appropriately applied.Release Notes page correctly marked with AI-generated content notice, consistent with other modified files.
api-features/fee-breakdowns.mdx (1)
6-8: Warning block implementation consistent and properly placed.api-features/query-payments.mdx (1)
6-8: Warning block implementation follows established pattern.use-cases/subscriptions.mdx (2)
3-3: Description updated to emphasize crypto subscription focus.Changed from general language ("Automate recurring payments with flexible billing cycles") to crypto-specific positioning ("Implement recurring crypto payments for subscription-based business models"). This is more targeted and aligns with product positioning. Ensure this aligns with product/marketing strategy.
6-8: AI-generated content warning properly applied.request-network-api/create-and-pay-requests.mdx (1)
7-9: Warning block properly positioned before content sections.api-setup/getting-started.mdx (1)
6-8: AI-generated warning appropriately applied to onboarding guide.Consistent implementation supports transparency for users starting with the API.
resources/request-scan.mdx (1)
6-8: Warning block properly positioned before resource documentation.api-features/create-requests.mdx (1)
6-8: AI-generated content warning properly positioned.The warning block is well-integrated before the main content and appropriately transparent about the page's origin. The message balances disclosure with reassurance by directing users to stable docs and support for critical verification.
api-features/recurring-payments.mdx (1)
6-8: Warning block consistently applied.The AI-generated content warning follows the established format from other pages in this PR, maintaining consistency across the documentation.
api-features/conversion-payments.mdx (1)
6-8: Consistent warning integration.The warning block is appropriately positioned and follows the established pattern across all feature pages.
glossary.mdx (1)
5-7: Warning appropriately added to reference material.The glossary's comprehensive nature makes the AI-generated content disclosure particularly important. The warning is well-positioned before the definitions.
api-features/payment-types-overview.mdx (1)
6-8: Warning consistently applied across feature documentation.The warning block maintains the established pattern and helps users understand this is an AI-generated guide requiring verification for critical use cases.
api-reference/authentication.mdx (1)
6-8: Transparency critical for authentication reference material.Given the security-sensitive nature of API authentication guidance, the AI-generated content warning is particularly important here. Users are appropriately directed to verify critical details with stable docs before implementing in production.
resources/community.mdx (1)
6-8: Warning appropriately applied to community resource guide.The warning is well-positioned before the resource content, ensuring users understand the page was AI-generated while directing them to authoritative channels.
use-cases/invoicing.mdx (6)
6-8: Warning block properly integrated into enhanced use-case guide.The AI-generated content warning is appropriately positioned and especially valuable given the expanded scope of this page with multiple new sections (Quickstart, EasyInvoice Demo, Integration Options).
3-3: Improved description specificity.The updated description ("Create crypto invoices with automatic payment detection and reconciliation") is more specific and informative than the implied original, helping users quickly understand the page's purpose.
16-37: Practical Quickstart section enhances usability.The new Quickstart section with four clear steps (Create Invoice → Share Payment Link → Get Paid → Track Payment) provides immediately actionable guidance and improves the page's utility for developers just starting out.
39-59: EasyInvoice Demo section bridges gap between documentation and practice.The new demo section with video and live demo links helps users move from learning to hands-on experience. Ensure the demo links are functional and up-to-date; the video link currently points to "#".
Verify that:
- The demo video link (currently "#") is updated with the actual video URL
- The live demo URL "https://easy-invoice-demo.vercel.app" is functional and maintained
68-106: Integration Options section clearly delineates three implementation paths.Excellent addition: presenting "Use As-Is," "Fork & Customize," and "Custom Implementation" approaches helps users self-select the right path. However, all three tabs currently link to "#" or missing links—ensure these are functional before merge.
Verify the following links/resources are in place:
- "Deploy EasyInvoice" link (line 81)
- "Fork Repository" link (line 93)
- "Setup Guide" link (line 93)
These currently point to "#" and need to reference actual resources.
108-158: Key API Features section provides excellent navigation to related capabilities.The six-card layout (Create Requests, Conversion Payments, Recurring Payments, Webhooks, Partial Payments, Custom Metadata) effectively cross-links to complementary features. However, some href values need review.
Several card hrefs appear inconsistent or incomplete:
- Line 113:
/api-features/payment-types(should this be/api-features/create-requestsbased on title?)- Line 121:
/api-features/payment-types(duplicate; should be/api-features/conversion-payments?)- Line 129:
/api-features/payment-types(duplicate; should be/api-features/recurring-payments?)- Line 137:
/api-features/advanced-features(verify this path exists)- Line 145:
/api-features/payment-types(should be/api-features/partial-payments?)- Line 153:
/api-features/advanced-features(verify this path exists)Verify that href values accurately reference the intended documentation pages.
docs.json (1)
34-34: Banner text update aligns with PR objectives.Line 34 correctly updates the banner reference from "Landing page" to "Welcome page", reflecting the current documentation structure.
sdk-legacy/overview.mdx (4)
1-12: Missing AI-generated content warning.Per the PR objectives, AI-generated content warnings should be added to documentation pages, with specific exclusions (Welcome, Payment Demo, Webhooks, NEAR docs). This new
sdk-legacy/overview.mdxpage is not listed as excluded and appears to be AI-generated based on its comprehensive structure. If this page was created with AI assistance, it should include a warning callout about potential inaccuracies before the main content.Consider adding a warning block consistent with other pages in this PR at the top of the content section (after frontmatter but before the "## Request Network SDK" heading).
35-44: Comparison table provides clear SDK vs API guidance.The API vs SDK comparison table (lines 37–44) effectively communicates the trade-offs and helps developers make informed decisions about which tool to use. The table accurately highlights that NEAR support is SDK-only and emphasizes the API's advantages in webhooks and payment processing automation.
46-50: Verify external resource links remain valid.The Resources section links to the legacy documentation site (
https://docs.request.network) and the SDK GitHub repository. Ensure these external links remain stable. If the legacy docs site is eventually deprecated, these links should be updated or removed.
11-12: All internal links are correctly referenced and verified.The internal links in sdk-legacy/overview.mdx are accurate and properly configured:
- Line 11 & 52:
/api-setup/getting-started→ file exists and matches docs.json- Line 30:
/api-setup/migrate-to-v2→ file exists and matches docs.jsonHowever, external link validation cannot be completed in this environment. Manually verify the availability of:
https://docs.request.network/advanced/request-network-sdk(line 26)https://docs.request.network(line 50)https://github.com/RequestNetwork/requestNetwork(line 51)
Problem
Beta documentation pages contain AI-generated content that may have inaccuracies. Users need clear warnings about content reliability. Additionally, the v2 migration guide was incorrectly placed under SDK (Legacy) instead of API setup.
Proposed Solution
Considerations
Warning message strikes balance between transparency and confidence - acknowledges AI generation while noting content is "likely close to accurate". Links to stable docs and support for verification of critical details.
Summary by CodeRabbit