Conversation
- Add API Reference page for SDKs (Kotlin, JS/TS) and CLI documentation - Create reusable snippets for SDKs and CLI so they can be included anywhere - Add CLI command reference, configuration guide, and end-to-end example - Fix mermaid diagram parse error in README (opt → alt for else support) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Greptile SummaryThis PR adds a new SDKs & CLI page to the API Reference section, introducing reusable snippets ( All feedback from the previous review round has been addressed:
One remaining issue: Step 5 of the end-to-end example calls Confidence Score: 4/5Safe to merge once the missing transactionId source in step 5 is clarified for users. All prior review concerns are resolved and the overall structure is solid. One P1 documentation gap remains: the end-to-end example leaves users stranded at step 5 with no guidance on where to obtain the
|
| Filename | Overview |
|---|---|
| mintlify/snippets/cli.mdx | New CLI snippet with installation, command reference, and end-to-end example. Previous review concerns (Steps component, prerequisites, missing command) are resolved, but step 5 references a <transactionId> that no prior step produces. |
| mintlify/snippets/sdks.mdx | New SDK cards snippet using CardGroup with JS/TS and Kotlin links; Kotlin now uses the custom SVG icon added in this PR (addressing the prior java-icon comment). |
| mintlify/api-reference/sdks.mdx | New API reference page composing the two snippets; valid frontmatter, existing code.svg icon, and correct og:image field. |
| mintlify/docs.json | Appends api-reference/sdks to the API Reference navigation group — minimal, correct change. |
| mintlify/images/icons/kotlin.svg | New custom Kotlin icon SVG using a diamond/arrow path that represents the Kotlin logo shape. |
| README.md | Fixes mermaid parse error by replacing opt (no else support) with alt (supports else branches) — correct fix. |
Sequence Diagram
sequenceDiagram
participant User
participant CLI as Grid CLI
participant API as Grid API
participant Sandbox
User->>CLI: grid customers create ...
CLI->>API: POST /customers
API-->>CLI: customerId
CLI-->>User: customerId
User->>CLI: grid accounts external create --customer-id
CLI->>API: POST /accounts/external
API-->>CLI: externalAccountId
CLI-->>User: externalAccountId
User->>CLI: grid quotes create --source-customer --dest-account
CLI->>API: POST /quotes
API-->>CLI: quoteId
CLI-->>User: quoteId
User->>CLI: grid sandbox send --quote-id
CLI->>Sandbox: Simulate USDC deposit
Sandbox-->>CLI: (transactionId?)
CLI-->>User: (transactionId not surfaced)
Note over User,CLI: ⚠️ transactionId source unclear
User->>CLI: grid transactions get transactionId
CLI->>API: GET /transactions/{id}
API-->>CLI: transaction status
CLI-->>User: status
Prompt To Fix All With AI
This is a comment left during a code review.
Path: mintlify/snippets/cli.mdx
Line: 113-116
Comment:
**`<transactionId>` placeholder has no source in the example flow**
Step 5 tells the user to run `grid transactions get <transactionId>`, but no earlier step produces or surfaces a transaction ID. The flow goes: customer → external account → quote → sandbox send — none of these visibly emit a `transactionId`.
A user following this guide literally will be stuck at step 5 with no `<transactionId>` to substitute. Consider one of:
1. Add an explicit sub-step after step 4 showing how to retrieve the ID, e.g.:
```suggestion
<Step title="Check transaction status">
```bash
# First, find the transaction ID from the list
grid transactions list
# Then fetch the details
grid transactions get <transactionId>
```
</Step>
```
2. Or note that `grid sandbox send` returns the transactionId in its output and show the expected output snippet so users know where to copy it from.
How can I resolve this? If you propose a fix, please make it concise.Reviews (3): Last reviewed commit: "Add custom Kotlin SVG icon for SDK card" | Re-trigger Greptile
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add `grid transactions get` to commands table - Convert example to use `<Steps>` component - Change Kotlin card icon from `java` to `kotlin` Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
snippets/sdks.mdx,snippets/cli.mdx) so the content can be included on any pageopt→altto supportelse)Test plan
make lintand confirm no new warningsmint devand verify the SDKs & CLI page renders under API Reference🤖 Generated with Claude Code