docs: update API documentation, commit guidelines, and optimize Sandpack processing - #59
Merged
Conversation
Cache the profile values once instead of allocating a new array for each profile lookup during API sandbox processing. Preserve the existing lookup behavior while avoiding repeated Object.values calls.
Read and transform independent API Markdown files concurrently while aggregating results in source order. Preserve the existing output ordering, validation counts, and write mode behavior.
…ack-processing perf: process API Sandpack files concurrently
…profiles perf: cache API sandbox profile lookups
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Synchronizes the
devbranch intomain, refreshing API reference documentation fortextmode.export.js(including categorized navigation and new video export models), updating contributing guidelines for shared commit hooks, and optimizing API Sandpack example build processing.Changes
1. API Reference Documentation
textmode.export.jsAPI reference with revised TypeDoc category organization (Workflow,Canvas capture,GIF export,Video export,Layer data export,JSON document data,Overlay).VideoQuality,VideoQualityLevel,VideoSaveDestination, and updatedVideoExportOptionsandVideoExportProgress.lastModifiedmetadata timestamps across ecosystem package API reference pages.2. Contributing Guidelines
docs/contributing/code.mdto reflect the use of@textmode/releasecommitlint preset and managedcommit-msghook.3. API Sandpack Build Performance
scripts/api-sandpack-examples.mjsto prevent repeated allocations during processing.Promise.all()while maintaining deterministic source ordering, validations, and write operations.