Skip to content

docs(getting-started): remove AI warning and refactor to focus on practical payment integration#53

Open
aimensahnoun wants to merge 1 commit into03-01-docs_api-portal_migrate_page_content_and_localize_assets_remove_ai-generated_warning_banner_from_api_portal_page_after_verifying_content_matches_legacy_gitbook_documentation._replace_gitbook-hosted_screenshot_with_local_webp_copfrom
03-01-docs_api-setup_replace_ai-generated_getting_started_with_verified_content_migrate_getting_started_page_from_ai-generated_placeholder_to_verified_content_based_on_legacy_integration_tutorial._remove_ai_warning_banner_correct_acco
Open

docs(getting-started): remove AI warning and refactor to focus on practical payment integration#53
aimensahnoun wants to merge 1 commit into03-01-docs_api-portal_migrate_page_content_and_localize_assets_remove_ai-generated_warning_banner_from_api_portal_page_after_verifying_content_matches_legacy_gitbook_documentation._replace_gitbook-hosted_screenshot_with_local_webp_copfrom
03-01-docs_api-setup_replace_ai-generated_getting_started_with_verified_content_migrate_getting_started_page_from_ai-generated_placeholder_to_verified_content_based_on_legacy_integration_tutorial._remove_ai_warning_banner_correct_acco

Conversation

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Mar 2, 2026

TL;DR

Removed AI-generated content warning and rewrote the getting started guide to focus on practical payment creation with Node.js examples instead of general API testing.

What changed?

  • Removed the AI-generated content warning banner
  • Simplified the quick setup steps to focus on payment creation workflow
  • Replaced multiple account type cards with a single account creation card
  • Streamlined API key generation instructions into a single flow
  • Removed the "Choose Your Path" section with use case cards
  • Replaced generic API testing examples with a complete Node.js payment integration tutorial
  • Added webhook setup instructions with signature verification
  • Updated environment configuration to use RN_ prefixed variables
  • Simplified troubleshooting section to focus on common integration issues
  • Updated "What's Next?" section to point to API features instead of use cases

How to test?

  1. Follow the Node.js integration example in the updated guide
  2. Create a .env file with the specified API key format
  3. Run the payment creation script to verify it works with the new structure
  4. Test the webhook endpoint setup if implementing real-time payment tracking

Why make this change?

The guide was too generic and focused on broad concepts rather than helping developers get started quickly. The new version provides a concrete, working example that developers can run immediately to understand how Request Network payments work, making it more actionable and practical for first-time users.

…ontent

Migrate Getting Started page from AI-generated placeholder to verified content
based on legacy Integration Tutorial. Remove AI warning banner, correct account
setup information (no testnet separation, single account type), and add accurate
Node.js integration examples with webhook handling.
Also update Integration Tutorial links to /api-setup/ path for consistency.
Copy link
Member Author

aimensahnoun commented Mar 2, 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 2, 2026
@aimensahnoun aimensahnoun changed the title docs(api-setup): replace AI-generated Getting Started with verified content Migrate Getting Started page from AI-generated placeholder to verified content based on legacy Integration Tutorial. Remove AI warning banner, correct account setup information (n docs(getting-started): remove AI warning and refactor to focus on practical payment integration Mar 2, 2026
@aimensahnoun aimensahnoun marked this pull request as ready for review March 2, 2026 12:02
@greptile-apps
Copy link

greptile-apps bot commented Mar 2, 2026

Greptile Summary

This PR successfully removes the AI-generated warning and refactors the getting started guide to provide a practical, hands-on Node.js integration example. The new approach is more actionable and focused on helping developers create their first payment request quickly.

Key improvements:

  • Replaced generic concepts with working Node.js code examples
  • Added webhook setup with signature verification
  • Simplified environment configuration with RN_ prefixed variables
  • Streamlined troubleshooting section

Issues found:

  • Authentication header inconsistency: uses X-Api-Key instead of x-api-key (used elsewhere in docs)
  • Webhook code references undefined app variable - missing Express setup context
  • Broken link to /api-setup/integration-tutorial (file doesn't exist)

These issues should be fixed to ensure developers can follow the guide without errors.

Confidence Score: 3/5

  • Safe to merge after fixing authentication header inconsistency, broken link, and incomplete webhook example
  • Documentation-only PR with good intent but contains errors that would confuse developers: inconsistent API header naming, incomplete code examples, and broken internal links. These are straightforward fixes but important for developer experience.
  • getting-started.mdx needs fixes for authentication header (use lowercase x-api-key), add Express setup context for webhook example, and correct the broken integration-tutorial link

Important Files Changed

Filename Overview
api-setup/getting-started.mdx Refactored from generic guide to practical Node.js tutorial, but contains authentication header inconsistencies, a broken link to integration-tutorial, and incomplete webhook setup code

Last reviewed commit: a6b536c

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.

1 file reviewed, 4 comments

Edit Code Review Agent Settings | Greptile

method: 'POST',
headers: {
'Authorization': `Bearer ${process.env.REQUEST_NETWORK_API_KEY}`,
'X-Api-Key': process.env.RN_API_KEY,
Copy link

Choose a reason for hiding this comment

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

inconsistent header name - use lowercase x-api-key to match the rest of the documentation

Suggested change
'X-Api-Key': process.env.RN_API_KEY,
'x-api-key': process.env.RN_API_KEY,

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

const crypto = require('crypto');

// Webhook handler
app.post('/webhooks', async (req, res) => {
Copy link

Choose a reason for hiding this comment

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

app is undefined - the example is missing Express setup

Add setup context before this code:

const express = require('express');
const app = express();
app.use(express.json());

- Check environment (testnet vs mainnet)
- Ensure API key has required permissions
- Verify Authorization header format
- Check that you're using the right header: `X-Api-Key`
Copy link

Choose a reason for hiding this comment

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

inconsistent header reference - use lowercase x-api-key to match the rest of the documentation

Suggested change
- Check that you're using the right header: `X-Api-Key`
- Check that you're using the right header: `x-api-key`

Copy link
Contributor

@bassgeta bassgeta left a comment

Choose a reason for hiding this comment

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

Looking good, leaner and cleaner 💯
Maybe we could still implement Greptile's recommendations, they aren't that much work

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.

2 participants