fix docs ci checks

Author: RhysSullivan

docs/snippets/sdk/quickstart/add-source.mdx

@@ -1,7 +1,7 @@
-{/*
-  This file is generated by scripts/generate-doc-snippets.ts.
-  Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
-*/}
+{/_
+This file is generated by scripts/generate-doc-snippets.ts.
+Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
+_/}
 
 ```ts
 await executor.openapi.addSpec({

docs/snippets/sdk/quickstart/close-executor.mdx

@@ -1,7 +1,7 @@
-{/*
-  This file is generated by scripts/generate-doc-snippets.ts.
-  Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
-*/}
+{/_
+This file is generated by scripts/generate-doc-snippets.ts.
+Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
+_/}
 
 ```ts
 await executor.close();

docs/snippets/sdk/quickstart/create-executor.mdx

@@ -1,7 +1,7 @@
-{/*
-  This file is generated by scripts/generate-doc-snippets.ts.
-  Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
-*/}
+{/_
+This file is generated by scripts/generate-doc-snippets.ts.
+Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
+_/}
 
 ```ts
 const executor = await createExecutor({

docs/snippets/sdk/quickstart/inspect-schema.mdx

@@ -1,7 +1,7 @@
-{/*
-  This file is generated by scripts/generate-doc-snippets.ts.
-  Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
-*/}
+{/_
+This file is generated by scripts/generate-doc-snippets.ts.
+Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
+_/}
 
 ```ts
 const schema = await executor.tools.schema("inventory.listItems");

docs/snippets/sdk/quickstart/list-tools.mdx

@@ -1,7 +1,7 @@
-{/*
-  This file is generated by scripts/generate-doc-snippets.ts.
-  Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
-*/}
+{/_
+This file is generated by scripts/generate-doc-snippets.ts.
+Edit examples/docs-sdk-quickstart/src/main.ts between the docs:start/docs:end markers instead.
+_/}
 
 ```ts
 const tools = await executor.tools.list({ sourceId: "inventory" });

examples/docs-sdk-quickstart/CHANGELOG.md

@@ -0,0 +1,6 @@
+# @executor-js/example-docs-sdk-quickstart changelog
+
+This file exists for `changesets/action@v1` compatibility (it reads every
+workspace package's `CHANGELOG.md` to build the Version Packages PR).
+Canonical user-facing release notes are at `apps/cli/release-notes/next.md`
+and on the GitHub Releases page.

examples/docs-sdk-quickstart/src/main.ts

@@ -77,30 +77,28 @@ const executor = await createExecutor({
 });
 // docs:end create-executor
 
-try {
-  // docs:start add-source
-  await executor.openapi.addSpec({
-    namespace: "inventory",
-    scope: "docs-workspace",
-    spec: JSON.stringify(inventoryApi),
-  });
-  // docs:end add-source
+// docs:start add-source
+await executor.openapi.addSpec({
+  namespace: "inventory",
+  scope: "docs-workspace",
+  spec: JSON.stringify(inventoryApi),
+});
+// docs:end add-source
+
+// docs:start list-tools
+const tools = await executor.tools.list({ sourceId: "inventory" });
 
-  // docs:start list-tools
-  const tools = await executor.tools.list({ sourceId: "inventory" });
+for (const tool of tools) {
+  console.log(`${tool.id}: ${tool.description}`);
+}
+// docs:end list-tools
 
-  for (const tool of tools) {
-    console.log(`${tool.id}: ${tool.description}`);
-  }
-  // docs:end list-tools
+// docs:start inspect-schema
+const schema = await executor.tools.schema("inventory.listItems");
 
-  // docs:start inspect-schema
-  const schema = await executor.tools.schema("inventory.listItems");
+console.log(schema?.inputTypeScript ?? "No input required");
+// docs:end inspect-schema
 
-  console.log(schema?.inputTypeScript ?? "No input required");
-  // docs:end inspect-schema
-} finally {
-  // docs:start close-executor
-  await executor.close();
-  // docs:end close-executor
-}
+// docs:start close-executor
+await executor.close();
+// docs:end close-executor

scripts/generate-doc-snippets.ts

@@ -64,7 +64,7 @@ for (const source of sources) {
     await mkdir(dirname(output), { recursive: true });
     await writeFile(
       output,
-      `{/*\n  This file is generated by scripts/generate-doc-snippets.ts.\n  Edit ${source.source} between the docs:start/docs:end markers instead.\n*/}\n\n\`\`\`${source.language}\n${dedent(lines)}\n\`\`\`\n`,
+      `{/_\nThis file is generated by scripts/generate-doc-snippets.ts.\nEdit ${source.source} between the docs:start/docs:end markers instead.\n_/}\n\n\`\`\`${source.language}\n${dedent(lines)}\n\`\`\`\n`,
     );
   }
 }