inngest-js icon indicating copy to clipboard operation
inngest-js copied to clipboard

[BUG]: Old Secrets Link Used in Types documentation comments

Open dthyresson opened this issue 1 year ago • 0 comments

Describe the bug

Related to https://github.com/inngest/inngest-js/commit/164fd5ccf86c3de4b55defa95efb5701569545f3

See: "@link https://app.inngest.com/secrets}" is still old link

export interface RegisterOptions {
  /**
   * A key used to sign requests to and from Inngest in order to prove that the
   * source is legitimate.
   *
   * You must provide a signing key to communicate securely with Inngest. If
   * your key is not provided here, we'll try to retrieve it from the
   * `INNGEST_SIGNING_KEY` environment variable.
   *
   * You can retrieve your signing key from the Inngest UI inside the "Secrets"
   * section at {@link https://app.inngest.com/secrets}. We highly recommend
   * that you add this to your platform's available environment variables as
   * `INNGEST_SIGNING_KEY`.
   *
   * If no key can be found, you will not be able to register your functions or
   * receive events from Inngest.
   */
  signingKey?: string;

Should be:

"https://app.inngest.com/env/production/manage/signing-key"

Expected behavior

The links should match.

The dev server was updated, but the code docs still have old link.

dthyresson avatar Apr 25 '23 18:04 dthyresson