Skip to content

Remove AI-generated content warnings and update internal links#77

Open
aimensahnoun wants to merge 1 commit into03-03-docs_resources_align_lifecycle-of-a-request_with_legacy_content_and_local_assets_update_resources_lifecycle-of-a-request.mdx_to_match_legacy_lifecycle_documentation_while_removing_legacy-hosted_dependencies._-_removed_ai-generatfrom
03-03-docs_resources_update_faq_and_glossary_with_legacy-aligned_content_and_accurate_links_refine_faq.mdx_and_glossary.mdx_to_keep_legacy_structure_content_while_removing_migration_artifacts_and_fixing_outdated_references._-_removed_
Open

Remove AI-generated content warnings and update internal links#77
aimensahnoun wants to merge 1 commit into03-03-docs_resources_align_lifecycle-of-a-request_with_legacy_content_and_local_assets_update_resources_lifecycle-of-a-request.mdx_to_match_legacy_lifecycle_documentation_while_removing_legacy-hosted_dependencies._-_removed_ai-generatfrom
03-03-docs_resources_update_faq_and_glossary_with_legacy-aligned_content_and_accurate_links_refine_faq.mdx_and_glossary.mdx_to_keep_legacy_structure_content_while_removing_migration_artifacts_and_fixing_outdated_references._-_removed_

Conversation

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Mar 3, 2026

TL;DR

Removed AI-generated content warnings and updated internal documentation links to use relative paths instead of absolute URLs.

What changed?

  • Removed the AI-generated content warning boxes from both the FAQ and Glossary pages
  • Updated all internal documentation links to use relative paths (e.g., /resources/supported-chains-and-currencies instead of https://docs.request.network/get-started/supported-chains)
  • Removed a security warning about private key handling from the FAQ
  • Updated the crypto-to-fiat payments answer to reflect current API support
  • Fixed minor formatting inconsistencies with punctuation and spacing

How to test?

  1. Verify that all internal links navigate correctly to their intended pages
  2. Check that the FAQ and Glossary pages render properly without the warning boxes
  3. Confirm that external links (like GitHub discussions) still work as expected

Why make this change?

The AI-generated content warnings were no longer needed as the content has been reviewed and validated. Using relative paths for internal links improves maintainability and ensures links work correctly across different deployment environments. The changes also reflect current product capabilities, such as crypto-to-fiat payment support via the API.

…and accurate links

Refine `faq.mdx` and `glossary.mdx` to keep legacy structure/content while removing migration artifacts and fixing outdated references.
- removed AI-generated warning banners from both pages
- preserved legacy FAQ/Glossary layout and core definitions
- updated FAQ answers that were no longer accurate (notably crypto-to-fiat support)
- replaced generic or confusing references with feature-specific links where appropriate
- cleaned old `docs.request.network` dependencies and moved to current internal/docs links where possible
- fixed inconsistent link behavior in FAQ responses to improve readability and navigation
This was referenced Mar 3, 2026
Copy link
Member Author

aimensahnoun commented Mar 3, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@aimensahnoun aimensahnoun self-assigned this Mar 3, 2026
@aimensahnoun aimensahnoun changed the title docs(resources): update FAQ and Glossary with legacy-aligned content and accurate links Refine faq.mdx and glossary.mdx to keep legacy structure/content while removing migration artifacts and fixing outdated references. - removed AI-generated warning Remove AI-generated content warnings and update internal links Mar 3, 2026
@aimensahnoun aimensahnoun marked this pull request as ready for review March 3, 2026 14:47
@greptile-apps
Copy link

greptile-apps bot commented Mar 3, 2026

Greptile Summary

This PR removes AI-generated content warnings from faq.mdx and glossary.mdx, converts absolute https://docs.request.network/... links to relative paths, and updates the crypto-to-fiat FAQ answer to reflect current API support. All internal links have been verified to resolve to existing pages.

Key changes:

  • AI-generated content warning banners removed from both pages — appropriate now that content has been reviewed
  • Internal links updated to relative paths (e.g., /glossary#payment-reference, /resources/supported-chains-and-currencies)
  • Crypto-to-fiat FAQ answer updated from "not currently supported" to reflect live API support

Issues requiring attention:

  1. Security guidance removed: A comprehensive security warning about process.env.PRIVATE_KEY exposure in client-side code was removed, but the risky code example remains in the FAQ. Readers may follow this pattern without understanding the frontend security risks.
  2. Incomplete question answer: The FAQ question asks about both crypto-to-fiat (off-ramp) AND fiat-to-crypto (on-ramp) payments, but the updated answer addresses only crypto-to-fiat. The on-ramp direction is left completely unanswered.
  3. Downgraded documentation links: Three glossary entries (Payment Reference, Swap-to-pay, Swap-to-Conversion) previously linked to specific SDK guide pages but now point to the generic /sdk-legacy/overview, reducing reference specificity.

Confidence Score: 2/5

  • Content quality issues that should be addressed: removed security guidance paired with risky code example, incomplete FAQ answer, and downgraded documentation references.
  • While the structural changes (link conversions, formatting) are technically safe and all relative links resolve correctly, there are three substantive content regressions: (1) security warning removed while dangerous code remains in a frontend context, (2) question about on-ramp support is unanswered despite being asked, and (3) three glossary links downgraded from specific guides to generic overview. These issues should be resolved before shipping to avoid misleading readers.
  • Both files require attention: faq.mdx needs security guidance restored and the on-ramp question addressed; glossary.mdx should either restore specific SDK guide links or explain why documentation is no longer available.

Last reviewed commit: 0ef3c12

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 files reviewed, 3 comments

Edit Code Review Agent Settings | Greptile

Comment on lines 52 to 54
<Accordion title="Does Request Network support crypto-to-fiat (off-ramp) or fiat-to-crypto (on-ramp) payments?">
Not currently, but we're working on it.
Crypto-to-fiat payments are supported via the Request Network API. See [Crypto-to-fiat Payments](/api-features/crypto-to-fiat-payments).
</Accordion>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On-ramp (fiat-to-crypto) part of question left unanswered

The accordion title explicitly asks about both "crypto-to-fiat (off-ramp) or fiat-to-crypto (on-ramp) payments", but the answer only addresses the crypto-to-fiat direction. A reader looking for on-ramp information will find no answer here.

Recommendation: Add a brief sentence clarifying the status of on-ramp support. For example: "Fiat-to-crypto on-ramp payments are not currently supported via the API." This ensures the answer fully addresses the question asked.

Comment on lines 101 to +115
### Payment Reference

In the Reference-based Payment Networks, Payments are linked to Requests via a `paymentReference` which is derived from the `requestId` and payment recipient address. For details see [Payment Reference](https://docs.request.network/advanced/request-network-sdk/sdk-guides/request-client/payment-reference)
In the Reference-based Payment Networks, Payments are linked to Requests via a `paymentReference` which is derived from the `requestId` and payment recipient address. For details see [SDK (Legacy)](/sdk-legacy/overview).

### Conversion Payment

A "conversion" request is denominated in one currency but paid in another currency. This is facilitated by on-chain price feeds provided by oracles. The typical use case is to denominate a request in fiat like USD and pay the request in stablecoins like USDC or DAI. For details see [Conversion Payment](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/conversion-request)
A "conversion" request is denominated in one currency but paid in another currency. This is facilitated by on-chain price feeds provided by oracles. The typical use case is to denominate a request in fiat like USD and pay the request in stablecoins like USDC or DAI. For details see [Conversion Payments](/api-features/conversion-payments).

### Swap-to-pay Payment

A "swap-to-pay" payment is where the payment sender sends one currency but the payment recipient receives a different currency. For details see [Swap-to-Pay Payment](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/swap-to-pay-request)
A "swap-to-pay" payment is where the payment sender sends one currency but the payment recipient receives a different currency. For details see [SDK (Legacy)](/sdk-legacy/overview).

### Swap-to-Conversion Payment

A "swap-to-conversion" payment is where the request is denominated in currency A, the payer sends currency B and the payee receives currency C. For details see [Swap-to-Conversion Payment](https://docs.request.network/advanced/request-network-sdk/sdk-guides/payment/swap-to-conversion-request)
A "swap-to-conversion" payment is where the request is denominated in currency A, the payer sends currency B and the payee receives currency C. For details see [SDK (Legacy)](/sdk-legacy/overview).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Three glossary "For details" links changed from specific guides to generic overview

Three glossary entries were updated to link to the generic /sdk-legacy/overview instead of their original specific guide pages:

  • Payment Reference (line 103): was payment-reference guide
  • Swap-to-pay Payment (line 111): was swap-to-pay-request guide
  • Swap-to-Conversion Payment (line 115): was swap-to-conversion-request guide

The "For details see" text now points readers to a generic overview rather than documentation specific to each concept, reducing the usefulness of these reference links.

Recommendation: If the specific SDK guide pages still exist (even under sdk-legacy/), consider linking to them directly for more targeted documentation. If those pages have been removed, update the prose to reflect that detailed documentation is unavailable rather than implying the overview provides concept-specific details.

@greptile-apps
Copy link

greptile-apps bot commented Mar 3, 2026

Additional Comments (1)

faq.mdx
Security guidance removed while dangerous code example remains

The security warning block that previously explained risks of exposing private keys in client-side code was deleted in this PR, but the process.env.PRIVATE_KEY code example on lines 72–75 still demonstrates this pattern. Readers following this snippet could inadvertently expose private keys in browser bundles or version control without understanding the risks.

Recommendation: Either restore a condensed security note alongside the code snippet, or replace the example pattern with a safer alternative (e.g., Web3 wallet providers like MetaMask, or server-side signing). This is especially important since the snippet shows a frontend context (HttpMetaMaskDataAccess).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant