Skip to content

Refactor useBuyModal documentation #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

mithatakbulut
Copy link
Contributor

@mithatakbulut mithatakbulut commented Aug 12, 2025

  • Added detailed usage examples for both market(secondary sales) and shop(primary sales), and improved parameter and return type sections for better understanding of the hook's functionality.
  • Examples include useLowestListing and useListPrimarySaleItems. It is best practice to have them both working together. Also added docs for these hooks and linked them in useBuyModal hook.

…Updated title and description, added detailed usage examples, and improved parameter and return type sections for better understanding of the hook's functionality.
@mithatakbulut mithatakbulut self-assigned this Aug 12, 2025
@mithatakbulut mithatakbulut requested a review from a team as a code owner August 12, 2025 13:37
mithatakbulut and others added 8 commits August 12, 2025 13:37
Sync file structure, format locales. Branch: 149/merge
Sync file structure, format locales. Branch: 149/merge
* fix sidekick docker command

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 150/merge

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Add Shops docs

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 143/merge

* Update shop docs assets

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 143/merge

* Minor update

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 143/merge

* Apply fixes

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 143/merge

* Remove ERC-721 contracts reference in docs

* Update ERC-1155 sale creation steps

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 143/merge

* Update

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Max Reg <[email protected]>
* Revise Marketplace SDK overview content

* Enhance Getting Started guide for Marketplace SDK

* Reorganize the documentation structure for the Marketplace SDK, creating distinct groups for "Marketplace SDK", "Hooks", and "Marketplace Actions".

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 148/merge

* Update description in Getting Started guide for Marketplace SDK to focus on installation, configuration, and the make offer feature.

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 148/merge

* Enhance Getting Started guide for Marketplace SDK by adding a new section for SDK configuration, including instructions for creating a configuration file and replacing placeholder values with actual project credentials. Additionally, clarify the default behavior of the `shadowDom` setting in the SDK configuration.

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 148/merge

* rename NFTCard to CollectibleCard

* refactor line: Optimized data fetching with React Query and  Wagmi

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 148/merge

* showcase `useMarketplaceConfig` and get contract address, chain id from its data. use them in useCollectible params

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 148/merge

* remove shadowDom note. it should be mentioned in another page clearly and with examples

* add width and height to image

* Enhance CollectibleCard component with loading and error states

* improve clarity and type safety by extracting collection properties.

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 148/merge

* Refactor getting started guide to replace ConnectButton with CollectibleCard component.

* Update SDK overview link to point to the marketplace SDK documentation.

* chore(i18n): update translations [en]

Sync file structure, format locales. Branch: 148/merge

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@mithatakbulut mithatakbulut marked this pull request as draft August 14, 2025 15:10
@mithatakbulut mithatakbulut changed the title Refactor useBuyModal documentation to enhance clarity and usability Refactor useBuyModal documentation Aug 18, 2025
@mithatakbulut mithatakbulut marked this pull request as ready for review August 18, 2025 08:36
@JamesLawton JamesLawton merged commit 96373be into marketplace-sdk-overview-and-getting-started Aug 20, 2025
1 check passed
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.

4 participants