-
Notifications
You must be signed in to change notification settings - Fork 10
Documentation for dev and copilot #4384
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
…luding component documentation
…iting them completely
…copy them to component folder
…egrate it into [component].md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a comprehensive documentation generation system to provide context for GitHub Copilot and generate developer documentation. It implements automated workflows to extract component API documentation, CSS variables, and code examples into unified Markdown files.
- Automated documentation generation pipeline combining TypeDoc API docs, SassDoc CSS variables, and Mitosis-generated code examples
- Copilot instructions generation that merges all component documentation into a centralized context file
- Package installation hooks to automatically propagate Copilot instructions to consuming projects
Reviewed Changes
Copilot reviewed 27 out of 28 changed files in this pull request and generated 6 comments.
Show a summary per file
File | Description |
---|---|
showcases/patternhub/scripts/generate-example-jsx.js |
Removes legacy JSX example generation script |
scripts/typedoc.json |
Adds TypeDoc configuration for API documentation generation |
scripts/package.json |
Adds documentation build pipeline scripts and dependencies |
scripts/documentation/*.js |
New documentation processing scripts for merging, extracting, and copying |
scripts/documentation/README.md |
Comprehensive guide for the documentation generation workflow |
packages/components/tsconfig.typedoc.json |
TypeScript configuration for TypeDoc generation |
packages/components/src/components/drawer/drawer.scss |
Adds SassDoc annotations for CSS variables |
packages/components/src/components/button/model.ts |
Adds comprehensive JSDoc documentation for Button types |
packages/components/src/components/button/docs/button.docs.lite.tsx |
New Mitosis documentation examples file |
packages/components/src/components/button/docs/*.md |
Removes old framework-specific documentation files |
packages/components/src/components/button/button.scss |
Adds SassDoc annotations for CSS variables |
packages/components/src/components/button/button.lite.tsx |
Adds JSDoc documentation for Button component |
packages/components/src/components/button/Button.md |
New unified component documentation |
packages/components/package.json |
Adds postinstall hook and new build scripts |
packages/components/configs/mitosis.snippet.config.cjs |
Configuration for generating code snippets from Mitosis |
packages/components/.sassdocrc.json |
SassDoc configuration |
package.json |
Adds copilot script and fast-glob dependency |
docs/llms.txt |
Table of contents for LLM context |
docs/adr/adr-05-copilot-developer-doc.md |
ADR documenting the documentation strategy |
.github/copilot-instructions.md |
Central Copilot instructions file |
…ation # Conflicts: # .xo-config.cjs # output/react/package.json # output/vue/package.json # package-lock.json # package.json # packages/components/package.json # packages/components/src/components/button/button.lite.tsx # packages/components/src/components/button/docs/Migration.md # packages/components/src/components/button/model.ts # packages/foundations/package.json # scripts/package.json # showcases/patternhub/scripts/generate-example-jsx.js
… docs-copilot-documentation
"commander": "^14.0.0", | ||
"glob": "^11.0.2" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"commander": "^14.0.0", | |
"glob": "^11.0.2" | |
"commander": "14.0.0", | |
"glob": "11.0.3" |
after integrated this code, you would most likely need to recreate the package lock file again.
"tsx": "^4.19.4", | ||
"vitest": "^3.2.1" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"tsx": "^4.19.4", | |
"vitest": "^3.2.1" | |
"tsx": "4.19.4", | |
"vitest": "3.2.4" |
after integrated this code, you would most likely need to recreate the package lock file again.
Proposed changes
closes #1349
Types of changes
Further comments