📝 Document adding a new package (#291)

cc @julien-c

CONTRIBUTING.md

@@ -19,3 +19,13 @@ It's not a hard requirement, but please consider using an icon from [Gitmoji](ht
 ## Tests
 
 If you want to run only specific tests, you can do `pnpm test -- -t "test name"`
+
+## Adding a package
+
+- Add the package name in [`pnpm-workspace.yaml`](pnpm-workspace.yaml)
+- Add a `package.json` inspired from the other packages ([`packages/hub/package.json`](packages/hub/package.json) / [`packages/agents/package.json`](packages/agents/package.json)) in `packages/<package name>/package.json`
+- Run `pnpm install` at the root
+- Edit [`packages/doc-internal/package.json`](packages/doc-internal/package.json) and add the two commands in the `scripts` section:
+  - `prepublish-<package name>`
+  - `doc-<package name>`
+- Add the `<package-name>-publish.yml` file in the `.github/workflows` folder, inspired from the other packages

package.json

@@ -21,6 +21,7 @@
 		"@vitest/browser": "^0.29.7",
 		"semver": "^7.5.0",
 		"tsup": "^6.7.0",
+		"ts-node": "^10.9.1",
 		"vitest": "^0.29.4",
 		"webdriverio": "^8.6.7"
 	}

packages/doc-internal/fix-cdn-versions.ts

@@ -3,12 +3,7 @@ import { readFileSync, writeFileSync } from "fs";
 const hubPackage = JSON.parse(readFileSync("../hub/package.json").toString());
 const inferencePackage = JSON.parse(readFileSync("../inference/package.json").toString());
 
-for (const readme of [
-	"../../README.md",
-	"../../packages/hub/README.md",
-	"../../packages/inference/README.md",
-	"../../packages/agents/README.md",
-]) {
+for (const readme of ["../../README.md", "../../packages/hub/README.md", "../../packages/inference/README.md"]) {
 	let content = readFileSync(readme, "utf-8");
 
 	content = content.replace(

packages/doc-internal/package.json

@@ -25,7 +25,6 @@
 	"license": "MIT",
 	"devDependencies": {
 		"@types/node": "^18.14.5",
-		"ts-node": "^10.9.1",
 		"typedoc": "^0.23.26",
 		"typedoc-plugin-markdown": "^3.14.0",
 		"typescript": "^4.9.5"

packages/inference/package.json

@@ -51,9 +51,7 @@
 	},
 	"devDependencies": {
 		"@types/node": "18.13.0",
-		"ts-node": "^10.9.1",
-		"typescript": "^5.0.4",
-		"vite": "^4.1.4"
+		"typescript": "^5.0.4"
 	},
 	"resolutions": {}
 }