Skip to content

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 20 commits into
base: main
Choose a base branch
from
Draft

Documentation for dev and copilot #4384

wants to merge 20 commits into from

Conversation

michaelmkraus
Copy link
Contributor

@michaelmkraus michaelmkraus commented Jun 16, 2025 •
edited by nmerget
Loading

Proposed changes

  • Generate context for copilot and generate documentation for developers

closes #1349

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (fix on existing components or architectural decisions)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Further comments

@michaelmkraus michaelmkraus self-assigned this Jun 16, 2025
@michaelmkraus michaelmkraus added the 📕documentation Improvements or additions to documentation label Jun 16, 2025
@michaelmkraus
feat(): add postinstall script to copy copilot instruction to corresp…
5b34e33 
…onding file
@michaelmkraus
docs: document automated postinstall propagation of copilot-instructi…
93076c2 
…ons.md
@michaelmkraus
feat: add generate-copilot-instructions script with PascalCase folder…
314cd06 
…/file filtering
@michaelmkraus
docs: document automated generation of copilot-instructions.md by inc…
730e839 
…luding component documentation
@michaelmkraus
docs: adapt jsdoc for button and its models
c528673
@michaelmkraus
chore: add plugin to merge typedoc files
6133886
@michaelmkraus
feat: append component doc to existing instructions instead of overwr…
c11b057 
…iting them completely
@michaelmkraus
chore: add typedoc for doc generation
f2ad116
@michaelmkraus
chore: remove comment
793a26f
@michaelmkraus
feat: merge component documentations into [MyComponent].md files and …
1efbd0e 
…copy them to component folder
@michaelmkraus
feat: restructure script and add comments
1bc0087
@michaelmkraus
chore: delete existing md files within button docs folder
a88ae59
@michaelmkraus
feat: add script to generate framework-specific code snippets
e3d2125
@michaelmkraus
feat: use mitosis plugin instead of script to generate examples
63d7dbd
@michaelmkraus
feat: append example snippets for react, angular and vue to [componen…
fcea6f6 
…t].md
@michaelmkraus
feat: introduce sassdoc to generate md documentation for SCSS and int…
12367ed 
…egrate it into [component].md
@mfranzke mfranzke changed the title Documentation for dev and copilo Documentation for dev and copilot Jul 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mfranzke mfranzke

@nmerget nmerget

At least 1 approving review is required to merge this pull request.

Assignees

@michaelmkraus michaelmkraus

Labels
📕documentation Improvements or additions to documentation
Projects
UX Engineering Team Backlog
Status: No status
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Talk about a Styling API
1 participant
@michaelmkraus