docs(review): apply Tristan's two must-fix items from the final review#97
docs(review): apply Tristan's two must-fix items from the final review#97rodrigopavezi wants to merge 1 commit into
Conversation
(1) api-reference/wallet-authentication.mdx — SIWE message example now matches the actual server output from request-auth-api/auth.service.ts: - "Sign in to Request Network" → "Sign in to Request Network." (period per the source string) - Dropped the "Chain ID: 1" line (the server does not emit it) - Added "Expiration Time: <iso>" line (the server emits it after Issued At; used the same value the docs already show for `expiresAt`) (2) api-setup/getting-started.mdx — Client ID Generation steps - Added a prerequisite step pointing users to create a payment destination first, because the Client IDs section is only visible once a destination exists. - Empty-state button labelled "Generate your first Client ID" (the actual dashboard label for the first-Client-ID case, per ManageDestination/blocks/ClientIdsSection.tsx). "Generate New Client ID" is still mentioned as the post-first-creation label.
Greptile SummaryThis PR applies two targeted documentation corrections based on a final review: the SIWE challenge message example is updated to match the actual server output, and the Client ID generation steps now include the missing payment-destination prerequisite.
Confidence Score: 4/5Safe to merge; both changes are straightforward accuracy fixes with no functional risk. The changes are accurate and well-scoped. The only loose end is that the high-level Quick Setup steps at the top of getting-started.mdx still don't mention the payment-destination prerequisite, leaving a small gap between the overview and the detailed steps a user will eventually read. The Quick Setup Steps block in api-setup/getting-started.mdx (lines 12-25) warrants a quick check to decide whether to echo the prerequisite there. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A([Log in to Dashboard]) --> B{Payment destination\nexists?}
B -- No --> C[Click 'Set up payment destination'\non Home page]
C --> D[Choose chain + token]
D --> E[Destination created]
E --> F[Open Manage Destination]
B -- Yes --> F
F --> G{First Client ID?}
G -- Yes --> H[Click 'Generate your first Client ID']
G -- No --> I[Click 'Generate New Client ID']
H --> J[Copy & securely store Client ID]
I --> J
|
MantisClone
left a comment
MantisClone
left a comment
There was a problem hiding this comment.
LGTM. SIWE fix matches the server template exactly (period present, no Chain ID line, Expiration Time set 5 min after Issued At = matches existing expiresAt two lines below). getting-started Client ID Generation flow now reflects the actual Dashboard UI: destination-creation prerequisite + both button labels with their conditions. Verified against request-auth-api/src/auth/auth.service.ts:187-196 and request-dashboard/src/pages/ManageDestination/blocks/ClientIdsSection.tsx:107-129. Ready to ship.
2 participants
(1) api-reference/wallet-authentication.mdx — SIWE message example now
matches the actual server output from request-auth-api/auth.service.ts:
per the source string)
At; used the same value the docs already show for
expiresAt)(2) api-setup/getting-started.mdx — Client ID Generation steps
destination first, because the Client IDs section is only visible
once a destination exists.
actual dashboard label for the first-Client-ID case, per
ManageDestination/blocks/ClientIdsSection.tsx). "Generate New Client
ID" is still mentioned as the post-first-creation label.