Restructure some docs and update the cli commands

Author: ericallam

docs/cli-init-commands.mdx

@@ -24,12 +24,17 @@ yarn dlx trigger.dev@latest init
 
 ## Options
 
+<ParamField body="Javascript" type="--javascript">
+  By default, the init command assumes you are using TypeScript. Use this flag to initialize a
+  project that uses JavaScript.
+</ParamField>
+
 <ParamField body="Project ref" type="--project-ref | -p">
   The project ref to use when initializing the project.
 </ParamField>
 
 <ParamField body="Package tag" type="--tag | -t">
-  The version of the `@trigger.dev/sdk` package to install. Defaults to `3.0.0-beta.56`.
+  The version of the `@trigger.dev/sdk` package to install. Defaults to `latest`.
 </ParamField>
 
 <ParamField body="Skip package install" type="--skip-package-install">

docs/mint.json

@@ -74,6 +74,18 @@
     {
       "source": "/reattempting-replaying",
       "destination": "/replaying"
+    },
+    {
+      "source": "/tasks-overview",
+      "destination": "/tasks/overview"
+    },
+    {
+      "source": "/tasks-scheduled",
+      "destination": "/tasks/scheduled"
+    },
+    {
+      "source": "/trigger-folder",
+      "destination": "/config/config-file"
     }
   ],
   "anchors": [
@@ -95,20 +107,21 @@
         "introduction",
         "quick-start",
         "how-it-works",
-        "limits",
-        "changelog",
-        "roadmap"
+        "limits"
       ]
     },
     {
       "group": "Fundamentals",
       "pages": [
-        "trigger-folder",
-        "tasks-overview",
+        {
+          "group": "Tasks",
+          "pages": [
+            "tasks/overview",
+            "tasks/scheduled"
+          ]
+        },
         "triggering",
         "apikeys",
-        "tasks-regular",
-        "tasks-scheduled",
         {
           "group": "Configuration",
           "pages": [
@@ -249,7 +262,9 @@
       "pages": [
         "open-source-self-hosting",
         "open-source-contributing",
-        "github-repo"
+        "github-repo",
+        "changelog",
+        "roadmap"
       ]
     },
     {

docs/snippets/cli-commands-deploy.mdx

@@ -24,11 +24,9 @@ yarn dlx trigger.dev@latest deploy
 It performs a few steps to deploy:
 
 1. Optionally updates packages when running locally.
-2. Typechecks the code.
-3. Compiles and bundles the code.
-4. Checks that [environment variables](/deploy-environment-variables) are set.
-5. Deploys the code to the cloud.
-6. Registers the tasks as a new version in the environment (prod by default).
+2. Compiles and bundles the code.
+3. Deploys the code to the Trigger.dev instance.
+4. Registers the tasks as a new version in the environment (prod by default).
 
 You can also setup [GitHub Actions](/github-actions) to deploy your tasks automatically.
 
@@ -38,28 +36,33 @@ You can also setup [GitHub Actions](/github-actions) to deploy your tasks automa
   Defaults to `prod` but you can specify `staging`.
 </ParamField>
 
-<ParamField body="Skip typecheck" type="--skip-typecheck">
-  Skips the pre-build typecheck step.
+<ParamField body="Set config filename" type="--config | -c">
+  The name of the config file, found where the command is run from. Defaults to `trigger.config.ts`.
+</ParamField>
+
+<ParamField body="Env file" type="--env">
+  Load environment variables from a file. This will only hydrate the `process.env` of the CLI
+  process, not the tasks.
+</ParamField>
+
+<ParamField body="Dry run" type="--dry-run">
+  Create a deployable build but don't deploy it. Prints out the build path so you can inspect it.
 </ParamField>
 
 <ParamField body="Skip update check" type="--skip-update-check">
   Skip checking for `@trigger.dev` package updates.
 </ParamField>
 
-<ParamField body="Build platform" type="--build-platform">
-  The platform to build the deployment image for. Defaults to `linux/amd64`.
+<ParamField body="Set the projectRef" type="--project-ref | -p">
+  The project ref. Required if there is no config file.
 </ParamField>
 
 <ParamField body="Log level" type="--log-level | -l">
   The log level to use (debug, info, log, warn, error, none). Defaults to `log`.
 </ParamField>
 
-<ParamField body="Set config filename" type="--config | -c">
-  The name of the config file, found where the command is run from. Defaults to `trigger.config.ts`.
-</ParamField>
-
-<ParamField body="Set the projectRef" type="--project-ref | -p">
-  The project ref. Required if there is no config file.
+<ParamField body="Skip syncing env vars" type="--skip-sync-env-vars">
+  Turn off syncing environment variables with the Trigger.dev instance.
 </ParamField>
 
 ## Self-hosting
@@ -76,15 +79,32 @@ These options are typically used when [self-hosting](/open-source-self-hosting)
   default registry.
 </ParamField>
 
+<ParamField body="Load image" type="--load-image">
+  Loads the image into your local docker after building it.
+</ParamField>
+
 <ParamField body="Registry" type="--registry">
-  **This option is coming soon.** The registry to push the image to when using --self-hosted.
+  Specify the registry to push the image to when using `--self-hosted`.
 </ParamField>
 
 <ParamField body="Push image" type="--push">
-  When using the --self-hosted flag, push the image to the default registry. (defaults to false when
-  not using --registry)
+  When using the --self-hosted flag, push the image to the registry.
 </ParamField>
 
-<ParamField body="Tag the image" type="--tag">
-  **This option is coming soon.** Specify the tag to use when pushing the image to the registry.
+<ParamField body="Namespace" type="--namepsace">
+  The namespace to use when pushing the image to the registry. For example, if pushing to Docker
+  Hub, the namespace is your Docker Hub username.
 </ParamField>
+
+### Push to Docker Hub
+
+An example of deploying to Docker Hub when using a self-hosted setup:
+
+```bash
+npx trigger.dev@latest deploy \
+  --self-hosted \
+  --load-image \
+  --push \
+  --registry docker.io \
+  --namespace mydockerhubusername
+```

docs/snippets/cli-commands-develop.mdx

@@ -18,7 +18,7 @@ yarn dlx trigger.dev@latest dev
 
 It will first perform an update check to prevent version mismatches, failed deploys, and other errors. You will always be prompted first.
 
-You will see in the terminal that the server is running and listening for requests. When you run a task, you will see it in the terminal along with a link to view it in the dashboard.
+You will see in the terminal that the server is running and listening for tasks. When you run a task, you will see it in the terminal along with a link to view it in the dashboard.
 
 It is worth noting that each task runs in a separate Node process. This means that if you have a long-running task, it will not block other tasks from running.
 
@@ -32,28 +32,9 @@ It is worth noting that each task runs in a separate Node process. This means th
   The project ref. Required if there is no config file.
 </ParamField>
 
-<ParamField body="Debugger" type="--debugger">
-  You can use this flag to run the server in debug mode. This will allow you to attach a debugger to the server and debug your tasks.
-
-<CodeGroup>
-
-```bash npm
-npx trigger.dev@latest dev --debugger
-```
-
-```bash pnpm
-pnpm dlx trigger.dev@latest dev --debugger
-```
-
-```bash yarn
-yarn dlx trigger.dev@latest dev --debugger
-```
-
-</CodeGroup>
-</ParamField>
-
-<ParamField body="Debug OpenTelemetry" type="--debug-otel">
-  Enable OpenTelemetry debugging.
+<ParamField body="Env file" type="--env">
+  Pass a custom path to an env file. We automatically detect `.env`, `.env.local`,
+  `.env.development`, and `.env.development.local` files.
 </ParamField>
 
 <ParamField body="Skip update check" type="--skip-update-check">
@@ -73,10 +54,6 @@ yarn dlx trigger.dev@latest dev --debugger
   does not affect the log level of your trigger.dev tasks. Defaults to `log`.
 </ParamField>
 
-<ParamField body="Skip telemetry" type="--skip-telemetry">
-  Opt-out of sending telemetry data.
-</ParamField>
-
 ## Standard options
 
 <ParamField body="Help" type="--help | -h">

docs/tasks-overview.mdx renamed to docs/tasks/overview.mdx

@@ -1,10 +1,10 @@
 ---
 title: "Tasks: Overview"
-sidebarTitle: "Tasks"
+sidebarTitle: "Overview"
 description: "Tasks are functions that can run for a long time and provide strong resilience to failure."
 ---
 
-There are different types of tasks including [regular tasks](/tasks-regular) and [scheduled tasks](/tasks-scheduled).
+There are different types of tasks including regular tasks and [scheduled tasks](/tasks/scheduled).
 
 ## Hello world task and how to trigger it
 
@@ -265,6 +265,80 @@ You can define a function that will be called when an error is thrown in the `ru
 
 Read more about `handleError` in our [Errors and Retrying guide](/errors-retrying).
 
+## Example tasks
+
+### A task that does an OpenAI call with retrying
+
+Sometimes OpenAI calls can take a long time to complete, or they can fail. This task will retry if the API call fails completely or if the response is empty.
+
+<OpenaiRetry />
+
+### A Task that sends emails in a sequence with delays in between
+
+This example uses Resend to send a sequence of emails over several days.
+
+Each email is wrapped in `retry.onThrow`. This will retry the block of code if an error is thrown. This is useful when you don't want to retry the whole task, but just a part of it. The entire task will use the default retrying, so can also retry.
+
+Additionally this task uses `wait.for` to wait for a certain amount of time before sending the next email. During the waiting time, the task will be paused and will not consume any resources.
+
+```ts /trigger/email-sequence.ts
+import { Resend } from "resend";
+
+const resend = new Resend(process.env.RESEND_ASP_KEY);
+
+export const emailSequence = task({
+  id: "email-sequence",
+  run: async (payload: { userId: string; email: string; name: string }) => {
+    console.log(`Start email sequence for user ${payload.userId}`, payload);
+
+    //send the first email immediately
+    const firstEmailResult = await retry.onThrow(
+      async ({ attempt }) => {
+        const { data, error } = await resend.emails.send({
+          from: "[email protected]",
+          to: payload.email,
+          subject: "Welcome to Trigger.dev",
+          html: `<p>Hello ${payload.name},</p><p>Welcome to Trigger.dev</p>`,
+        });
+
+        if (error) {
+          //throwing an error will trigger a retry of this block
+          throw error;
+        }
+
+        return data;
+      },
+      { maxAttempts: 3 }
+    );
+
+    //then wait 3 days
+    await wait.for({ days: 3 });
+
+    //send the second email
+    const secondEmailResult = await retry.onThrow(
+      async ({ attempt }) => {
+        const { data, error } = await resend.emails.send({
+          from: "[email protected]",
+          to: payload.email,
+          subject: "Some tips for you",
+          html: `<p>Hello ${payload.name},</p><p>Here are some tips for you…</p>`,
+        });
+
+        if (error) {
+          //throwing an error will trigger a retry of this block
+          throw error;
+        }
+
+        return data;
+      },
+      { maxAttempts: 3 }
+    );
+
+    //etc...
+  },
+});
+```
+
 ## Next steps
 
 <CardGroup>