Skip to content

Commit a2d9286

Browse files
authored
chore: relocate example and service template docs (#190)
1 parent 0c1a1c1 commit a2d9286

5 files changed

Lines changed: 7 additions & 9 deletions

File tree

File renamed without changes.

services/puppeteer-worker/src/examples.ts renamed to services/puppeteer-worker/examples/examples.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
* Clear examples showing how to use the simplified system
44
*/
55

6-
import { loadConfig } from "./config-loader.js";
7-
import { logger } from "./logger.js";
8-
import { PuppeteerRunner } from "./puppeteer-runner.js";
9-
import type { Config, SelfContainedEvent } from "./types.js";
6+
import { loadConfig } from "../src/config-loader.js";
7+
import { logger } from "../src/logger.js";
8+
import { PuppeteerRunner } from "../src/puppeteer-runner.js";
9+
import type { Config, SelfContainedEvent } from "../src/types.js";
1010

1111
// ============================================================================
1212
// BASIC USAGE EXAMPLES
@@ -381,8 +381,8 @@ if (import.meta.url === `file://${process.argv[1]}`) {
381381
Object.keys(EXAMPLES).forEach((name) => {
382382
logger.info(`- ${name}`);
383383
});
384-
logger.info("\nUsage: node examples.js <example-name>");
385-
logger.info(" node examples.js (to run all examples)");
384+
logger.info("\nUsage: tsx examples/examples.ts <example-name>");
385+
logger.info(" tsx examples/examples.ts (to run all examples)");
386386

387387
if (!exampleName) {
388388
runAllExamples().catch((err) =>

services/puppeteer-worker/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"worker:dist": "node dist/worker-main.js",
1919
"worker:env": "node --env-file=.env dist/worker-main.js",
2020
"dev": "tsx --watch src/index.ts",
21-
"examples": "node dist/examples.js",
21+
"examples": "tsx examples/examples.ts",
2222
"demo": "tsx src/index.ts"
2323
},
2424
"keywords": [],

services/puppeteer-worker/scripts/esbuild.mjs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ const rawPlugin = {
3535

3636
const nodeEntries = [
3737
"src/index.ts",
38-
"src/examples.ts",
3938
"src/worker-main.ts",
4039
// Include core modules to keep dist in sync for tests
4140
"src/file-capture.ts",

services/puppeteer-worker/src/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,6 @@ if (import.meta.url === `file://${process.argv[1]}`) {
4949
export { loadConfig } from "./config-loader.js";
5050
export { EventMonitor } from "./event-monitor.js";
5151
export { EventShipper } from "./event-shipper.js";
52-
export * as Examples from "./examples.js";
5352
export { FileCapture } from "./file-capture.js";
5453
export { JobClient } from "./job-client.js";
5554
// Export main components for use as a library

0 commit comments

Comments
 (0)