docs: add JSDoc comments to 5 components#57
Open
clawgreen wants to merge 3 commits intoOpenKnots:mainfrom
Open
docs: add JSDoc comments to 5 components#57clawgreen wants to merge 3 commits intoOpenKnots:mainfrom
clawgreen wants to merge 3 commits intoOpenKnots:mainfrom
Conversation
- Added JSDoc to TerminalApp - Added JSDoc to TerminalHeader - Added JSDoc to TerminalPane - Added JSDoc to TerminalStatusBar - Added JSDoc to terminal-themes module Closes #8
|
@clawgreen is attempting to deploy a commit to the 0xBuns Team on Vercel. A member of the Team first needs to authorize it. |
- Added examples for TerminalTable with striped rows and alignment - Added TerminalTabs with keyboard navigation demo - Added TerminalSelect with option list Closes #11
BunsDev
added
blocked-infra
Contributor
|
Maintainer triage: this is useful work, but it should sit behind the repo-health fixes and the first wave of component decisions. It touches the playground surface that many feature PRs also edit, so it will be easier to land once the queue is narrower. |
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
2 participants
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.
What does this PR do?
Part 1: JSDoc Comments
Adds JSDoc documentation comments to 5 components for better IDE autocomplete:
TerminalApp- Full terminal application with tabs and split panesTerminalHeader- Tabbed header with traffic lights and theme switcherTerminalPane- Interactive terminal pane with command inputTerminalStatusBar- Status bar showing shell info and pane/tab countsterminal-themes- Theme system modulePart 2: Playground Examples
Adds missing component examples to the playground:
Type of Change
Checklist
pnpm run build)Screenshots
N/A - Documentation and examples only
Related Issues: