Docs #505
Draft
Docs #505
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sdk/src/react/hooks/data/orders/useListOffersForCollectible.tsx
Outdated
Show resolved
Hide resolved
sdk/src/react/hooks/transactions/useGenerateSellTransaction.tsx
Outdated
Show resolved
Hide resolved
sdk/src/react/hooks/transactions/useGenerateSellTransaction.tsx
Outdated
Show resolved
Hide resolved
sdk/src/react/hooks/transactions/useGenerateSellTransaction.tsx
Outdated
Show resolved
Hide resolved
…f TSDoc comments, custom markdown formatting, and improved README structure. Introduce functions for generating individual hook markdown files and category index files, ensuring comprehensive documentation for all hooks. Clean up the documentation directory before generation and provide a summary of documented hooks.
…arkdown. Update function names and file extensions accordingly, ensuring consistency across generated documentation files. Enhance README and category index generation to reflect the new MDX structure.
… generation Fix issue where JSDoc @example content was being double-wrapped in TypeScript code blocks, causing malformed markdown with nested code fences like: ```typescript With filtering: ```typescript // actual code here ``` ``` Changes made: - Remove extra code block wrapping from example section generation - Enhance extractHookDetails() to properly handle multiple @example tags - Render JSDoc example content directly as it's already properly formatted - Improve example collection logic to preserve formatting and spacing The generated documentation now correctly displays example descriptions as regular text followed by properly formatted single code blocks, eliminating the nested code block rendering issues.
…olished-docs Refactor script to generate polished docs
… script to streamline the output.
Remove the basic usage section from the hook documentation generation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.