Add: Transak Fiat Module Docs - #209
Conversation
ihsraham
left a comment
ihsraham
left a comment
There was a problem hiding this comment.
I left a few comments on completing the page set and aligning the community-module release path.
| <Card title="Usage Guide" href="/sdk/fiat-modules/fiat-transak/usage"> | ||
| Learn how to integrate Transak in your application | ||
| </Card> | ||
| <Card title="API Reference" href="/sdk/fiat-modules/fiat-transak/api-reference"> |
There was a problem hiding this comment.
Wouldn't it be better to include the API reference before linking it from these pages and the sidebar? The link check currently reports 22 broken links to this missing route.
There was a problem hiding this comment.
I just added the file @ihsraham. The file was missed because of the .gitignore rule.
| | Module | Provider | Status | Documentation | | ||
| |--------|----------|--------|---------------| | ||
| | [`@tetherto/wdk-protocol-fiat-moonpay`](https://github.com/tetherto/wdk-protocol-fiat-moonpay) | MoonPay | ✅ Ready | [Documentation](/sdk/fiat-modules/fiat-moonpay/) | | ||
| | [`@tetherto/wdk-protocol-fiat-transak`](https://github.com/tetherto/wdk-protocol-fiat-transak) | Transak | ✅ Ready | [Documentation](/sdk/fiat-modules/fiat-transak/) | |
There was a problem hiding this comment.
We can keep Ready here and the beta note on the overview. Let's keep this change in draft until @tetherto/wdk-protocol-fiat-transak@1.0.0 is published, then verify the installation link before moving it forward.
| | Module | Provider | Description | Documentation | | ||
| |--------|----------|-------------|---------------| | ||
| | [`@tetherto/wdk-protocol-fiat-moonpay`](https://github.com/tetherto/wdk-protocol-fiat-moonpay) | MoonPay | MoonPay integration for fiat on-ramp | [Docs](/sdk/fiat-modules/fiat-moonpay/) | | ||
| | [`@tetherto/wdk-protocol-fiat-transak`](https://github.com/tetherto/wdk-protocol-fiat-transak) | Transak | Transak integration for fiat on-ramp and off-ramp | [Docs](/sdk/fiat-modules/fiat-transak/) | |
There was a problem hiding this comment.
Wouldn't this source link need to point to Transak/wdk-protocol-fiat-transak? The current tetherto/wdk-protocol-fiat-transak URL returns 404, while the package manifest names the Transak repository.
| schemaType: TechArticle | ||
| --- | ||
|
|
||
| Use the Transak fiat module to build widget URLs and quotes that let users buy and sell cryptocurrency with fiat inside your application. The `widgetUrl` and `getOrder` callbacks run on your backend, where your Transak API secret stays safe. The module never touches it directly. |
There was a problem hiding this comment.
Since the module is maintained under the Transak organization, wouldn't it be better to follow the existing community-module treatment by adding the standard warning here and listing it in Community Modules?
|
@ihsraham, I am changing the PR to Draft for now because the package isn't published yet. |
2 participants
Add Transak fiat on-ramp/off-ramp docs
Adds full documentation for the new
@tetherto/wdk-protocol-fiat-transakmodule, covering setup, usage, and API reference, and registers it in the docs navigation matching the existing structure.📄 New pages
index.mdxusage.mdxconfiguration.mdxwidgetUrl,getOrder), staging vs. production, widget UI customization optionsapi-reference.mdxTransakProtocolguides/get-started.mdxTransakProtocolguides/buy-and-sell.mdxguides/manage-transactions.mdx🧭 Navigation
src/lib/custom-tree.ts(usage, guides, configuration, API reference), matching the existing structure@tetherto/wdk-protocol-fiat-transakto the fiat modules tables incontent/docs/sdk/all-modules.mdxandcontent/docs/sdk/fiat-modules/index.mdx