Documentation for dev and copilot #4384

michaelmkraus · 2025-06-16T07:26:25Z

Proposed changes

Generate context for copilot and generate documentation for developers
Evaluating providing our documentation as a Copilot knowledge base

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

…typedoc

…onding file

…ons.md

…/file filtering

…luding component documentation

…iting them completely

…copy them to component folder

…t].md

…egrate it into [component].md

… docs-copilot-documentation

packages/agent-cli/package.json

packages/foundations/agent/_instructions.md

scripts/documentation/merge-component-docs.ts

Co-authored-by: Maximilian Franzke <[email protected]>

packages/agent-cli/test/__snapshots__/index.spec.ts.snap

packages/agent-cli/README.md

* refactor: enhanced documentation * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update packages/agent-cli/README.md Co-authored-by: Copilot <[email protected]> * Update packages/agent-cli/README.md Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>

packages/agent-cli/README.md

michaelmkraus added 4 commits June 12, 2025 09:39

feat(doc): add basic copilot-instructions.md and llms.txt

9db5e8b

chore(): add typedoc to project

ea41c1f

chore(): add basic adr for copilot documentation

fdfb88e

docs(): add some documentation for component to test generation with …

006ca98

…typedoc

michaelmkraus self-assigned this Jun 16, 2025

michaelmkraus added this to UX Engineering Team Backlog Jun 16, 2025

michaelmkraus added the 📕documentation Improvements or additions to documentation label Jun 16, 2025

michaelmkraus added 16 commits June 16, 2025 17:14

feat(): add postinstall script to copy copilot instruction to corresp…

5b34e33

…onding file

docs: document automated postinstall propagation of copilot-instructi…

93076c2

…ons.md

feat: add generate-copilot-instructions script with PascalCase folder…

314cd06

…/file filtering

docs: document automated generation of copilot-instructions.md by inc…

730e839

…luding component documentation

docs: adapt jsdoc for button and its models

c528673

chore: add plugin to merge typedoc files

6133886

feat: append component doc to existing instructions instead of overwr…

c11b057

…iting them completely

chore: add typedoc for doc generation

f2ad116

chore: remove comment

793a26f

feat: merge component documentations into [MyComponent].md files and …

1efbd0e

…copy them to component folder

feat: restructure script and add comments

1bc0087

chore: delete existing md files within button docs folder

a88ae59

feat: add script to generate framework-specific code snippets

e3d2125

feat: use mitosis plugin instead of script to generate examples

63d7dbd

feat: append example snippets for react, angular and vue to [componen…

fcea6f6

…t].md

feat: introduce sassdoc to generate md documentation for SCSS and int…

12367ed

…egrate it into [component].md

mfranzke changed the title ~~Documentation for dev and copilo~~ Documentation for dev and copilot Jul 4, 2025

michaelmkraus added 6 commits July 10, 2025 11:50

feat: add script to extract sassdoc and save in md

2c4f59b

chore: move scripts to documentation subfolder

1ccc328

chore: add readme describing how to generate copilot-instructions.md

14b7a17

chore: adapt readme describing how to generate copilot-instructions.md

25c54e7

feat: fix typos in readme

8d1be02

chore: adapt skript calls and readme

cd80ca1

nmerget and others added 5 commits July 25, 2025 08:02

Merge remote-tracking branch 'origin/docs-copilot-documentation' into…

c692649

… docs-copilot-documentation

chore: add agent-cli to build outputs

66b0168

fix: issue with agent-cli bin

6170dde

chore: improve some ai related stuff

e7bf98b

Merge branch 'main' into docs-copilot-documentation

7cebac1

mfranzke reviewed Jul 25, 2025

View reviewed changes

packages/agent-cli/package.json Outdated Show resolved Hide resolved

mfranzke reviewed Jul 25, 2025

View reviewed changes

packages/agent-cli/package.json Outdated Show resolved Hide resolved

Update README.md

79e02c1

mfranzke reviewed Jul 30, 2025

View reviewed changes

packages/foundations/agent/_instructions.md Outdated Show resolved Hide resolved

mfranzke reviewed Jul 30, 2025

View reviewed changes

packages/foundations/agent/_instructions.md Outdated Show resolved Hide resolved

mfranzke reviewed Jul 30, 2025

View reviewed changes

packages/foundations/agent/_instructions.md Outdated Show resolved Hide resolved

mfranzke reviewed Jul 30, 2025

View reviewed changes

scripts/documentation/merge-component-docs.ts Outdated Show resolved Hide resolved

nmerget and others added 6 commits July 30, 2025 09:06

Update packages/foundations/agent/_instructions.md

9344550

Co-authored-by: Maximilian Franzke <[email protected]>

Update packages/foundations/agent/_instructions.md

f58c777

Co-authored-by: Maximilian Franzke <[email protected]>

Update scripts/documentation/merge-component-docs.ts

fcd1ba8

Co-authored-by: Maximilian Franzke <[email protected]>

Update packages/foundations/agent/_instructions.md

ae8c6a4

Co-authored-by: Maximilian Franzke <[email protected]>

Update packages/agent-cli/package.json

cb4f476

Co-authored-by: Maximilian Franzke <[email protected]>

Update packages/agent-cli/package.json

c206bd5

Co-authored-by: Maximilian Franzke <[email protected]>

mfranzke reviewed Jul 30, 2025

View reviewed changes

packages/agent-cli/test/__snapshots__/index.spec.ts.snap Show resolved Hide resolved

mfranzke reviewed Jul 30, 2025

View reviewed changes

packages/agent-cli/test/__snapshots__/index.spec.ts.snap Show resolved Hide resolved

mfranzke reviewed Jul 30, 2025

View reviewed changes

packages/agent-cli/README.md Outdated Show resolved Hide resolved

mfranzke and others added 4 commits July 30, 2025 10:24

Update packages/agent-cli/README.md

952dba8

Merge branch 'main' into docs-copilot-documentation

9ba3aa7

refactor: regenerated package lock file

1616965

mfranzke reviewed Jul 30, 2025

View reviewed changes

packages/agent-cli/README.md Show resolved Hide resolved

mfranzke and others added 3 commits July 31, 2025 10:29

docs: provide further information

6025a84

docs: added sample prompt

262ae9f

Merge branch 'main' into docs-copilot-documentation

7aee163

mfranzke marked this pull request as draft July 31, 2025 08:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Documentation for dev and copilot #4384

Documentation for dev and copilot #4384

Uh oh!

michaelmkraus commented Jun 16, 2025 •

edited by mfranzke

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Documentation for dev and copilot #4384

Are you sure you want to change the base?

Documentation for dev and copilot #4384

Uh oh!

Conversation

michaelmkraus commented Jun 16, 2025 • edited by mfranzke Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Types of changes

Further comments

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

michaelmkraus commented Jun 16, 2025 •

edited by mfranzke

Loading