Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
One or more issues must be addressed before approval.
5 open findings
What changed in this PR
Moves SDK documentation into the published @elgato/streamdeck package, alongside generators and documentation checks.
Changes:
- Adds Markdown documentation, historical snapshots, snippets, and navigation metadata.
- Introduces reference generation and documentation validation.
- Updates packaging and CI to ship and check documentation.
| File | Description |
|---|---|
| packages/plugin/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/tsconfig.build.json | Updated as part of this pull request. |
| packages/plugin/scripts/docs/utils/disposable.ts | Updated as part of this pull request. |
| packages/plugin/scripts/docs/generators/methods.ts | Updated as part of this pull request. |
| packages/plugin/scripts/docs/generate.ts | Updated as part of this pull request. |
| packages/plugin/scripts/docs/ast/structures/union.ts | Updated as part of this pull request. |
| packages/plugin/scripts/docs/ast/structures/type-parameter.ts | Updated as part of this pull request. |
| packages/plugin/scripts/docs/ast/structures/primitive.ts | Updated as part of this pull request. |
| packages/plugin/scripts/docs/ast/structures/index.ts | Updated as part of this pull request. |
| packages/plugin/scripts/docs/ast/structures/array.ts | Updated as part of this pull request. |
| packages/plugin/scripts/docs/ast/index.ts | Updated as part of this pull request. |
| packages/plugin/package.json | Updated as part of this pull request. |
| packages/plugin/eslint.config.mjs | Updated as part of this pull request. |
| packages/plugin/docs/v2/style-guide/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/releases/upgrading/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/references/websocket/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/references/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/introduction/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/index.md | Updated as part of this pull request. |
| packages/plugin/docs/v2/guides/system.md | Updated as part of this pull request. |
| packages/plugin/docs/v2/guides/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/references/layout/set-trigger-description.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/references/layout/set-feedback-value.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/references/layout/set-feedback-properties.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/references/layout/set-custom-layout.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/references/layout/set-built-in-layout.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/system/system-wake.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/system/open-url.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/zod.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/runtime-error.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/message-identifiers.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/global-set.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/global-get-untyped.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/global-get-typed.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/global-event.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/action-typed.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/action-set.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/action-event-args.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/settings/action-did-receive-settings.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/secrets/get-secrets.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/resources/set.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/resources/get.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/resources/audio-service.d.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/profiles/switch-to-profile.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/logging/scopes-nested.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/logging/scopes-main.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/logging/native.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/logging/logger.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/logging/log-level.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/logging/levels.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/i18n.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/devices/device-did-disconnect.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/devices/device-did-connect.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/devices/device-did-change.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/devices/available-devices.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/deep-linking/handler.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/deep-linking/example.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/app-monitoring/application-did-terminate.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/app-monitoring/application-did-launch.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/visible-actions.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/visible-actions-of-type.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/user-desired-state.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/set-title.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/set-title-with-options.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/set-image-with-options.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/set-image-svg.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/set-image-file.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/register.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/events.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/guides/actions/actions/log-key-press.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/getting-started/making-changes/counter.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/getting-started/making-changes/binary-counter.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/node/getting-started/making-changes/binary-counter-capped.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/trigger-description.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/pre-defined-profiles.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/plugin-property-inspector.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/invalid-custom-layout.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/dial-support.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/custom-layout.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/built-in-layout.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/basic.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/app-monitoring.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest/action-property-inspector.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/manifest.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/layouts/$x1.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/layouts/$c1.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/layouts/$b2.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/layouts/$b1.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/layouts/$a1.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/layouts/$a0.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/images/images.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/i18n/manifest.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/i18n/de.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/json/i18n/de-custom.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/browser/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/browser/index.ts | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/browser/guides/ui/remote.html | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/browser/guides/ui/remote-client.html | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/browser/guides/ui/local.html | Updated as part of this pull request. |
| packages/plugin/docs/v2/_snippets/browser/guides/ui/local-client.html | Updated as part of this pull request. |
| packages/plugin/docs/v1/style-guide/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/references/websocket/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/references/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/introduction/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/index.md | Updated as part of this pull request. |
| packages/plugin/docs/v1/guides/system.md | Updated as part of this pull request. |
| packages/plugin/docs/v1/guides/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/references/layout/set-trigger-description.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/references/layout/set-feedback-value.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/references/layout/set-feedback-properties.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/references/layout/set-custom-layout.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/references/layout/set-built-in-layout.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/system/system-wake.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/system/open-url.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/zod.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/runtime-error.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/global-set.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/global-get-untyped.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/global-get-typed.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/action-typed.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/action-set.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/action-event-args.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/settings/action-did-receive-settings.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/profiles/switch-to-profile.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/logging/scopes-nested.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/logging/scopes-main.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/logging/native.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/logging/logger.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/logging/log-level.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/logging/levels.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/i18n.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/devices/device-did-disconnect.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/devices/device-did-connect.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/devices/device-did-change.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/devices/available-devices.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/deep-linking/handler.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/deep-linking/example.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/app-monitoring/application-did-terminate.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/app-monitoring/application-did-launch.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/visible-actions.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/visible-actions-of-type.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/user-desired-state.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/set-title.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/set-title-with-options.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/set-image-with-options.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/set-image-svg.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/set-image-file.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/register.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/events.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/guides/actions/actions/log-key-press.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/getting-started/making-changes/counter.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/getting-started/making-changes/binary-counter.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/node/getting-started/making-changes/binary-counter-capped.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/trigger-description.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/pre-defined-profiles.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/plugin-property-inspector.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/invalid-custom-layout.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/dial-support.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/custom-layout.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/built-in-layout.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/basic.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/app-monitoring.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest/action-property-inspector.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/manifest.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/layouts/$x1.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/layouts/$c1.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/layouts/$b2.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/layouts/$b1.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/layouts/$a1.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/layouts/$a0.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/images/images.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/i18n/manifest.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/i18n/de.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/json/i18n/de-custom.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/guides/ui/remote.html | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/guides/ui/remote-client.html | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/guides/ui/local.html | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/guides/ui/local-client.html | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/guides/settings/global-event.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/guides/settings/action-settings-changed.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/guides/settings/action-on-did-connect.ts | Updated as part of this pull request. |
| packages/plugin/docs/v1/_snippets/browser/guides/settings/action-get-and-set.ts | Updated as part of this pull request. |
| packages/plugin/docs/style-guide/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/releases/upgrading/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/references/websocket/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/references/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/introduction/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/index.md | Updated as part of this pull request. |
| packages/plugin/docs/guides/system.md | Updated as part of this pull request. |
| packages/plugin/docs/guides/_category_.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/releases/upgrading/v3/neo-infobar.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/system/system-wake.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/system/open-url.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/zod.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/runtime-error.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/global-set.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/global-get-untyped.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/global-get-typed.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/global-event.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/action-typed.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/action-set.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/action-event-args.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/settings/action-did-receive-settings.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/resources/set.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/resources/get.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/resources/audio-service.d.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/profiles/switch-to-profile.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/neo-infobar/set-feedback-layout.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/neo-infobar/set-feedback-implicitly.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/neo-infobar/set-feedback-explicitly.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/logging/scopes-nested.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/logging/scopes-main.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/logging/native.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/logging/logger.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/logging/log-level.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/logging/levels.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/i18n.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/dials/set-trigger-description.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/dials/set-feedback-layout.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/dials/set-feedback-implicitly.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/dials/set-feedback-explicitly.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/devices/device-did-disconnect.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/devices/device-did-connect.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/devices/device-did-change.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/devices/available-devices.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/deep-linking/handler.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/deep-linking/example.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/app-monitoring/application-did-terminate.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/app-monitoring/application-did-launch.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/visible-actions.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/visible-actions-of-type.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/user-desired-state.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/set-title.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/set-title-with-options.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/set-image-with-options.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/set-image-svg.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/set-image-file.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/register.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/events.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/guides/actions/actions/log-key-press.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/getting-started/making-changes/counter.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/getting-started/making-changes/binary-counter.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/node/getting-started/making-changes/binary-counter-capped.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/trigger-description.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/pre-defined-profiles.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/plugin-property-inspector.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/dial-support.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/custom-layout.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/built-in-layout.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/basic.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/app-monitoring.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest/action-property-inspector.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/manifest.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/layouts/neo-infobar.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/layouts/custom-encoder.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/layouts/$x1.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/layouts/$c1.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/layouts/$b2.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/layouts/$b1.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/layouts/$a1.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/layouts/$a0.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/i18n/manifest.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/i18n/de.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/json/i18n/de-custom.jsonc | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/browser/tsconfig.json | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/browser/index.ts | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/browser/guides/ui/remote.html | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/browser/guides/ui/remote-client.html | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/browser/guides/ui/local.html | Updated as part of this pull request. |
| packages/plugin/docs/_snippets/browser/guides/ui/local-client.html | Updated as part of this pull request. |
| packages/plugin/AGENTS.md | Updated as part of this pull request. |
| packages/plugin/.markdownlint-cli2.jsonc | Updated as part of this pull request. |
| oxfmt.config.mts | Updated as part of this pull request. |
| .gitignore | Updated as part of this pull request. |
| .github/workflows/build.yml | Updated as part of this pull request. |
| .gitattributes | Updated as part of this pull request. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Render optional event handlers as valid function declarations, and update the visible actions example to set the title on each iterated action.
|
Replace the `{#id}` heading suffix with an `<a id>` tag before the
heading, which renders on GitHub and npm without a plugin.
Replace `> [!NOTE]` style alerts with Note, Tip, Warning and Error elements, with the content indented inside the element.
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
One or more issues must be addressed before approval.
0 open findings
4 resolved since last review
Previously missed (2)
In code that hasn't changed since last review
packages/plugin/docs/_snippets/node/guides/actions/set-image-svg.ts:12
A newly added action has no saved count, so its first key press computes undefined + 1 (NaN). setSettings serializes this as {"count":null}, and the initial image uses the wrong parity. Default the count to zero (for example with ?? 0) and regenerate the inlined keys guide.
packages/plugin/docs/v1/_snippets/node/guides/actions/set-image-svg.ts:12
With no saved settings, the first key press computes undefined + 1 (NaN) and persists count: null instead of incrementing from zero. Default the count with ?? 0, and update the matching example in docs/v1/guides/keys.md manually because historical pages are not regenerated.
🧠 Review effort: Balanced
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.
Summary
Moves the Stream Deck SDK documentation out of the legacy Docusaurus site and into this repository, shipped with
@elgato/streamdeckas GitHub Flavored Markdown underpackages/plugin/docs/.packages/plugin/scripts/docs/, retargeted to emit Markdown, and inline generated references (action commands and events, WebSocket API, manifest and layout definitions) and type-checked code snippets into the pages between HTML comment markers.docs/v1/anddocs/v2/as snapshots that are never regenerated. Navigation uses_category_.jsonfiles and frontmatter.filesnow includes./docs(excluding_snippets) and./AGENTS.md, which points agents at the documentation index. Runtime output is unchanged.pnpm docs:checkverifies the generated output is up to date, validates links, anchors, images, titles and category metadata, lints the Markdown with markdownlint, and type checks the snippets. CI runs it after the build.Notes
pnpm build && pnpm docs:generatemust be run after changing JSDoc, schema types, or snippets; CI fails with the list of stale pages otherwise.