chore: add jsdocs + extension docs auto-gen#783
Conversation
… main branch changes
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
…ions in field annotation
…ity and structure
…clarity and type definitions
harbournick
left a comment
harbournick
left a comment
There was a problem hiding this comment.
Great that we're adding this! Generally looking good - just have a lot of questions.
I tend to think we should actually stop using field-annotation for this initially and use a much simpler node (maybe document sections?) to validate the whole process since there so much happening here between ensuring types are generated correctly, JSDoc validations etc.
caio-pizzol
changed the title
…an up ESLint configuration
…s to enhance code quality
I liked your approach! Let me switch to Document Sections then (new docs are not official as well, so we can test it end to end first) |
…itions in super-editor
…ture in super-editor
…for better organization
There was a problem hiding this comment.
Pull Request Overview
This PR adds JSDoc documentation standards and automatic documentation generation for the super-editor extensions. The changes establish TypeScript configuration for type checking, implement JSDoc linting rules, and set up a GitHub workflow to trigger documentation updates when extension files are modified.
- Added JSDoc type definitions and documentation to document-section extension
- Configured TypeScript compiler for type generation and checking
- Set up ESLint with JSDoc plugin for documentation validation
- Created GitHub workflow to auto-trigger documentation repository updates
Reviewed Changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/super-editor/tsconfig.json | Updated TypeScript config for type generation with new target and output directory |
| packages/super-editor/tsconfig.build.json | New build-specific TypeScript configuration extending base config |
| packages/super-editor/src/extensions/structured-content/document-section.js | Added comprehensive JSDoc type definitions and improved command documentation |
| packages/super-editor/package.json | Updated build scripts to use new TypeScript configuration and added type checking commands |
| package.json | Added ESLint JSDoc plugin and new linting commands for documentation validation |
| eslint.config.docs.mjs | New ESLint configuration specifically for JSDoc validation in extension files |
| .github/workflows/trigger-docs-update.yml | New GitHub workflow to trigger documentation updates when extensions change |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…formatting in super-editor
…ation in Editor class
…ns (#798) * chore: add vite aliases to tsconfig * fix: remove ts-ignore and fix issues to ensure file builds
harbournick
deleted the
feature/har-10244-4-superdoc-docs-automate-documentation-generation-for
branch
No description provided.