feat: add table module documentation + keyboard shortcuts#818
Merged
harbournick merged 10 commits intodevelopfrom Aug 27, 2025
Merged
feat: add table module documentation + keyboard shortcuts#818harbournick merged 10 commits intodevelopfrom
harbournick merged 10 commits intodevelopfrom
Conversation
Contributor
caio-pizzol
commented
Aug 27, 2025
caio-pizzol
commented
- Added keyboard shortcuts for bold (Mod-b, Mod-B), italic (Mod-i, Mod-I), underline (Mod-u, Mod-U), highlight (Mod-Shift-h), and strikethrough (Mod-Shift-s).
- Enhanced table module with detailed configuration options, commands, and helper functions for better usability and documentation clarity.
…ce table module documentation - Added keyboard shortcuts for bold (Mod-b, Mod-B), italic (Mod-i, Mod-I), underline (Mod-u, Mod-U), highlight (Mod-Shift-h), and strikethrough (Mod-Shift-s). - Enhanced table module with detailed configuration options, commands, and helper functions for better usability and documentation clarity.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Simplified the syntax of command functions in the table extension by removing unnecessary line breaks and indentation. - Improved overall code clarity while maintaining functionality.
- Added detailed JSDoc comments for table extension options and attributes to improve documentation clarity. - Removed unused helper functions related to cell creation and column styling to streamline the codebase.
- Improved documentation by adding detailed JSDoc comments for attributes in bold, highlight, link, document section, table, table cell, table header, table row, and underline extensions. - Ensured clarity and consistency in attribute descriptions to aid developers in understanding usage.
- Revised JSDoc comments to enhance clarity by changing the UnderlineType definition to an object type with a value property for style variants. - Improved formatting of command functions for better readability.
… attributes - Eliminated outdated JSDoc type definitions for TableCellAttributes and TableHeaderAttributes to streamline the codebase. - Improved overall documentation clarity by focusing on relevant attributes.
harbournick
requested changes
Aug 27, 2025
Collaborator
harbournick
left a comment
harbournick
left a comment
There was a problem hiding this comment.
Mainly comments to remove internal helpers. It does highlight the point that we need to more clearly decide what is an internal helper (ie: to be used inside a command) vs what should be external 'helpers' API
- Added detailed JSDoc comments for various table helper functions to improve documentation clarity. - Introduced a new command in package.json to run all checks, including formatting, linting, and type building for better code quality assurance. - Removed unused type definitions and helper functions to streamline the codebase.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation and keyboard shortcuts to table and text formatting modules, enhancing usability through better API documentation and standardized keyboard navigation.
- Added keyboard shortcuts for bold, italic, underline, highlight, and strikethrough formatting
- Enhanced table module with detailed JSDoc documentation for configuration options, commands, and helper functions
- Added TypeScript-style type definitions and usage examples throughout the codebase
Reviewed Changes
Copilot reviewed 23 out of 23 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/super-editor/src/extensions/underline/underline.js | Added keyboard shortcuts and improved type definitions for underline styles |
| packages/super-editor/src/extensions/table/table.js | Comprehensive documentation overhaul with command descriptions and configuration options |
| packages/super-editor/src/extensions/table/tableHelpers/*.js | Added JSDoc documentation and type definitions to helper functions |
| packages/super-editor/src/extensions/table-/table-.js | Enhanced table component documentation with attribute descriptions |
| packages/super-editor/src/extensions/*/bold.js, italic.js, etc. | Added keyboard shortcut documentation for text formatting marks |
| package.json | Added new check:all script for code quality validation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| /** | ||
| * @category Attribute | ||
| * @param {TableIndent} [tableIndent] - Table indentation configuration |
There was a problem hiding this comment.
The type 'TableIndent' is referenced but not defined anywhere in the file. This should reference the correct type from the TableAttributes typedef or be defined separately.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…tion - Updated the JSDoc type definition from UnderlineType to UnderlineConfig for clarity. - Adjusted parameter documentation to reflect the new type name, enhancing overall documentation consistency.
harbournick
deleted the
feature/har-10404-superdoc-docs-table-extension
branch
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
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.