Skip to content
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

Updated Documentation for v2.0.3.1028 #92

Merged
merged 4 commits into from
Oct 28, 2024
Merged

Updated Documentation for v2.0.3.1028 #92

merged 4 commits into from
Oct 28, 2024

Conversation

eric2788
Copy link
Owner

This pull request includes several changes across multiple files, focusing on adding documentation comments, enhancing hooks, and updating the contributing guidelines. The most important changes include the addition of documentation for various hooks and utilities, updates to the contributing guidelines, and improvements to existing hooks.

Documentation Enhancements:

  • src/background/messages/open-tab.ts: Added detailed JSDoc comments to the RequestBody type, providing examples and descriptions for each property.
  • src/hooks/form.ts: Added JSDoc comments to the useFileInput hook, explaining its purpose, parameters, and providing an example usage.
  • src/utils/binary.ts: Added JSDoc comments for various utility functions, including serializeBlobAsString, deserializeStringToBlob, serializeBlobAsNumbers, and screenshotFromVideo. [1] [2] [3] [4] [5] [6]

Hook Enhancements:

  • src/hooks/dom.ts: Enhanced the useQuerySelector hook to include a useMutationObserver for better element tracking and dynamic updates. [1]R1, [2]
  • src/hooks/stream.ts: Added JSDoc comments to useShardSender and useShardReceiver hooks, explaining their functionality and providing example usages. [1] [2]
  • src/hooks/styles.ts: Added JSDoc comments to useComputedStyle and useContrast hooks, detailing their purpose and usage.

Contributing Guidelines:

  • CONTRIBUTING.md: Updated the contributing guidelines to include the new llms directory and modified the conditions for triggering fast tests based on branch formats. [1] [2]

Code Cleanup:

  • src/features/recorder/components/RecorderButton.tsx: Removed unused imports to clean up the code.
  • src/hooks/dom.ts: Added the useMutationObserver import to support the enhanced useQuerySelector hook. (src/hooks/dom.tsL1-R1R1)

These changes collectively improve the codebase by adding necessary documentation, enhancing existing hooks, and updating the contributing guidelines for better clarity and functionality.

@eric2788 eric2788 added 补充 explanation 功能请求/增強 enhancement labels Oct 28, 2024
@eric2788 eric2788 added this to the v2.0~ milestone Oct 28, 2024
@eric2788 eric2788 self-assigned this Oct 28, 2024
@eric2788 eric2788 marked this pull request as draft October 28, 2024 07:26
@eric2788 eric2788 marked this pull request as ready for review October 28, 2024 09:10
@eric2788 eric2788 merged commit efe2e6c into master Oct 28, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
功能请求/增強 enhancement 补充 explanation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant