Skip to content

docs: add architecture pages and secure payment integration guide - #83

Open
AllenAJ wants to merge 4 commits into
RequestNetwork:mainfrom
AllenAJ:docs/architecture-pages-part-1
Open

docs: add architecture pages and secure payment integration guide#83
AllenAJ wants to merge 4 commits into
RequestNetwork:mainfrom
AllenAJ:docs/architecture-pages-part-1

Conversation

@AllenAJ

@AllenAJAllenAJ commented Mar 23, 2026

Copy link
Copy Markdown

Summary

  • Add new Resources architecture pages:
    • sdk-and-request-node-overview
    • payment-networks
    • private-requests-using-encryption
    • smart-contracts-overview
  • Update docs.json navigation to include the new architecture pages under Resources
  • Replace internal-only workflow with a public end-to-end secure payment integration guide in:
    • api-features/secure-payment-integration-guide.mdx

Why

This PR closes key public docs gaps by making:

  • protocol architecture easier to understand,
  • secure payment onboarding self-serve for partners.

Test plan

  • Previewed docs locally with mint dev
  • Verified nav entries and page rendering
  • Verified internal links
  • Checked lints on changed files (no issues)

Scope notes

@greptile-apps

Copy link
Copy Markdown

Greptile Summary

This PR adds four new architecture reference pages under resources/ (sdk-and-request-node-overview, payment-networks, private-requests-using-encryption, smart-contracts-overview) and registers them in the docs.json navigation, closing a significant gap between the Mintlify beta docs and the stable GitBook docs. It also substantially rewrites api-features/secure-payment-integration-guide.mdx from a backend-code-focused guide into a full end-to-end UI walkthrough covering wallet sign-in, payment destinations, Client IDs, webhooks, and payment links.

Key changes:

  • Four new architecture pages added and wired into the Resources → Architecture nav group
  • secure-payment-integration-guide.mdx rewritten with expanded step-by-step flow, supported-chain tables, field reference tables, and updated troubleshooting entries
  • docs.json navigation updated with four additional entries

Issues found:

  • resources/smart-contracts-overview.mdx lists "REQ token and burn mechanism contracts" as a third category in its overview, but no corresponding section exists in the page body — readers will find the category but no content
  • Per AGENTS.md, sequential procedures should use the <Steps> / <Step> Mintlify components; multiple pages (secure-payment-integration-guide.mdx, private-requests-using-encryption.mdx, sdk-and-request-node-overview.mdx) use plain numbered lists or H2 headings for step-by-step flows instead

Confidence Score: 4/5

  • Safe to merge after addressing the missing REQ token contracts section in the smart contracts overview.
  • The four new architecture pages are accurate, well-structured, and fill a genuine documentation gap. The docs.json navigation changes are correct. The main blocker is a content inconsistency in smart-contracts-overview.mdx where the overview promises a REQ token category that is never documented. The <Steps> component violations are style-guide issues worth fixing but do not affect accuracy or navigation.
  • resources/smart-contracts-overview.mdx — overview lists REQ token contracts as a category but the section is absent from the page body.

Important Files Changed

FilenameOverview
resources/smart-contracts-overview.mdxNew architecture page listing smart contract categories; overview claims three categories (Storage, Payment, REQ token) but the REQ token section is never documented in the body.
api-features/secure-payment-integration-guide.mdxSignificant rewrite from a backend-code-focused guide to a step-by-step UI walkthrough; uses H2 headings for sequential steps instead of the Mintlify <Steps> component required by the style guide.
resources/sdk-and-request-node-overview.mdxNew architecture page accurately describing SDK and Request Node interaction; sequential flow uses an ordered list instead of the <Steps> component.
resources/payment-networks.mdxNew architecture page clearly explaining payment network families and advanced types; content is accurate and well-structured.
resources/private-requests-using-encryption.mdxNew architecture page explaining the AES + asymmetric encryption model; encryption and decryption flows use numbered lists rather than the recommended <Steps> component.
docs.jsonNavigation updated correctly; four new architecture pages added under the existing Architecture group in Resources.

Sequence Diagram

sequenceDiagram
participant App as Your App
participant SDK as Request Network SDK
participant Node as Request Node
participant IPFS as IPFS
participant Chain as Smart Contracts (on-chain)
participant Graph as The Graph
App->>SDK: Create / update / pay request
SDK->>Node: Relay request content
Node->>IPFS: Persist encrypted/plain request payload
IPFS-->>Node: CID returned
Node->>Chain: Anchor CID on-chain (RequestHashStorage)
Chain-->>Node: Tx confirmed
Note over Chain,Graph: Payment proxy emits event with paymentReference
Chain->>Graph: Index storage & payment events
App->>SDK: Retrieve request / detect payment
SDK->>Node: Query request data
Node->>Graph: Fetch indexed events
Graph-->>Node: Events returned
Node-->>SDK: Request state + balance
SDK-->>App: Request object with payment status
Loading

Reviews (1): Last reviewed commit: "docs: add protocol architecture pages to..." | Re-trigger Greptile

Comment threadresources/smart-contracts-overview.mdx
Comment threadapi-features/secure-payment-integration-guide.mdx
Add a dedicated API setup page for connecting Claude Code and Cursor via MCP,
including Request Network Mintlify MCP and llms endpoints, then wire it into nav.
Made-with: Cursor
@AllenAJAllenAJ changed the title docs: add protocol architecture pages to mintlify resourcesdocs: add architecture pages, AI tools setup, and secure payment integration guideMar 23, 2026
@AllenAJAllenAJ changed the title docs: add architecture pages, AI tools setup, and secure payment integration guidedocs: add architecture pages and secure payment integration guideMar 23, 2026
Sign up for freeto 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

@AllenAJ@rodrigopavezi