Skip to content

[Bug] Broken Documentation Link #1653

Open
@sdedovic

Description

@sdedovic

What are you really trying to do?

I am learning how to build and deploy typescript workers. Some examples use code that has doctoring with broken links. I have been unable to find the documentation anywhere on the docs site. Guidance is appreciated.

Describe the bug

The following link is in the docstrings: https://docs.temporal.io/typescript/production-deploy#pre-build-code

and it does not resolve. I cannot find any supplemental documentation, but this seems quite important from the code.

This is the code: https://github.com/temporalio/sdk-typescript/blob/main/packages/worker/src/worker-options.ts#L158

Minimal Reproduction

Interaface WorkerOptions, field workflowBundle,

  /**
     * Use a pre-built bundle for Workflow code. Use {@link bundleWorkflowCode} to generate the bundle. The version of
     * `@temporalio/worker` used when calling `bundleWorkflowCode` must be the exact same version used when calling
     * `Worker.create`.
     *
     * This is the recommended way to deploy Workers to production.
     *
     * See https://docs.temporal.io/typescript/production-deploy#pre-build-code for more information.
     *
     * When using this option, {@link workflowsPath}, {@link bundlerOptions} and any Workflow interceptors modules
     * provided in * {@link interceptors} are not used. To use workflow interceptors, pass them via
     * {@link BundleOptions.workflowInterceptorModules} when calling {@link bundleWorkflowCode}.
     */
    workflowBundle?: WorkflowBundleOption;

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions