Skip to content

docs: remove stale prompt type utility example - #5018

Closed
KeuqS wants to merge 1 commit into
triggerdotdev:mainfrom
KeuqS:docs/remove-stale-prompt-type-utilities
Closed

KeuqS wants to merge 1 commit into
triggerdotdev:mainfrom
KeuqS:docs/remove-stale-prompt-type-utilities

Conversation

@KeuqS

@KeuqS KeuqS commented Oct 11, 2026 •

Copy link
Copy Markdown

Summary

Removes the stale Type utilities example from the Prompts documentation. The snippet imports PromptHandle, PromptIdentifier, and PromptVariables from @trigger.dev/sdk, but those types are not exported from the public SDK entrypoint and the example no longer compiles against the published package.

Why

Keeping a non-compiling snippet in the docs misleads users and causes snippet validation to fail. Removing the unsupported example keeps the page aligned with the public SDK surface.

Closes #4782

Testing

  • Confirmed the public SDK package exports prompts from the v3 entrypoint but does not re-export those three types from @trigger.dev/sdk.
  • Confirmed the stale section is removed from docs/ai/prompts.mdx.

Checklist

  • Documentation-only change; no changeset is required.
  • No runtime behavior changed.

@changeset-bot

changeset-bot Bot commented Oct 11, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: bbce100

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

Copy link
Copy Markdown
Contributor

Hi @KeuqS, thanks for your interest in contributing!

This project requires that pull request authors are vouched, and you are not in the list of vouched users.

This PR will be closed automatically. See https://github.com/triggerdotdev/trigger.dev/blob/main/CONTRIBUTING.md for more details.

@github-actions github-actions Bot closed this Oct 11, 2026
@coderabbitai

coderabbitai Bot commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 320f96ec-54e8-4678-b4b8-4d8cbe278817

📥 Commits

Reviewing files that changed from the base of the PR and between 93465d8 and bbce100.


📒 Files selected for processing (1)
  • docs/ai/prompts.mdx

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 code samples in your docs no longer compile

1 participant