Skip to content

Vouch request: Fixes for compiler-verified documentation examples #4986

Description

@kritikmodi

Why do you want to contribute?

I regularly test developer documentation against published SDKs to identify examples that no longer compile or behave as documented. I'm doing this to better understand this field and think of ways of improve it.

What I’d like to contribute

I tested Trigger.dev’s published TypeScript examples against TypeScript 5.9.3 and the current @trigger.dev packages (4.6.3).

I found 17 reproducible failures across the documentation, including invalid package entry points, outdated SDK properties, missing exports, and examples that do not compile as written.

For my first contribution, I’d like to submit a focused documentation PR correcting the invalid build-related imports currently shown in:

  • /docs/building-with-ai
  • /docs/guides/python/python-crawl4ai

The documented @trigger.dev/sdk/build and @trigger.dev/core/build entry points do not resolve against the published packages.

I have compiler reproductions and corrected examples for both cases. I’ll keep the PR narrowly scoped and open it as a draft, following the contribution guidelines.

GitHub: https://github.com/kritikmodi

Prior contributions or relevant experience

I’ve previously reproduced and contributed fixes for documentation and SDK drift.

Relevant contributions:

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions