Updated Documentation for v2.0.3.1028 #92
Merged
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.
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 theRequestBody
type, providing examples and descriptions for each property.src/hooks/form.ts
: Added JSDoc comments to theuseFileInput
hook, explaining its purpose, parameters, and providing an example usage.src/utils/binary.ts
: Added JSDoc comments for various utility functions, includingserializeBlobAsString
,deserializeStringToBlob
,serializeBlobAsNumbers
, andscreenshotFromVideo
. [1] [2] [3] [4] [5] [6]Hook Enhancements:
src/hooks/dom.ts
: Enhanced theuseQuerySelector
hook to include auseMutationObserver
for better element tracking and dynamic updates. [1]R1, [2]src/hooks/stream.ts
: Added JSDoc comments touseShardSender
anduseShardReceiver
hooks, explaining their functionality and providing example usages. [1] [2]src/hooks/styles.ts
: Added JSDoc comments touseComputedStyle
anduseContrast
hooks, detailing their purpose and usage.Contributing Guidelines:
CONTRIBUTING.md
: Updated the contributing guidelines to include the newllms
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 theuseMutationObserver
import to support the enhanceduseQuerySelector
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.