From 9888e39c7a509b96ea3750373d75607ebe78b981 Mon Sep 17 00:00:00 2001 From: MobileMage Date: Wed, 28 Oct 2026 01:21:33 +0100 Subject: [PATCH] chore(repo): link the npm pages to the docs and add search keywords Signed-off-by: MobileMage --- .changeset/npm-page-metadata.md | 8 ++++++++ packages/client/package.json | 12 ++++++++++-- packages/core/package.json | 12 ++++++++++-- packages/field/package.json | 11 +++++++++-- packages/react/package.json | 10 ++++++++-- 5 files changed, 45 insertions(+), 8 deletions(-) create mode 100644 .changeset/npm-page-metadata.md diff --git a/.changeset/npm-page-metadata.md b/.changeset/npm-page-metadata.md new file mode 100644 index 0000000..1c46b60 --- /dev/null +++ b/.changeset/npm-page-metadata.md @@ -0,0 +1,8 @@ +--- +'@gatepost/core': patch +'@gatepost/client': patch +'@gatepost/field': patch +'@gatepost/react': patch +--- + +Link the npm page of each package to its guide on the docs site, and add the search keywords for Nigeria's postcode. diff --git a/packages/client/package.json b/packages/client/package.json index 9bc27db..09afc76 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -3,7 +3,7 @@ "version": "0.1.0-alpha.0", "description": "Unofficial. Not made or endorsed by NIPOST. Call NIPOST's postcode gateway.", "license": "Apache-2.0", - "homepage": "https://github.com/gatepost-dev/js/tree/main/packages/client#readme", + "homepage": "https://gatepost-dev.github.io/docs/guides/typescript-client/", "bugs": "https://github.com/gatepost-dev/js/issues", "repository": { "type": "git", @@ -28,9 +28,17 @@ }, "keywords": [ "nigeria", + "nipost", "postcode", + "nigeria-postcode", + "nigerian-postcode", + "postal-code", + "postcode-validation", "address", - "nipost" + "address-validation", + "digital-postcode", + "api-client", + "nipost-api" ], "size-limit": [ { diff --git a/packages/core/package.json b/packages/core/package.json index a34c01d..79f582c 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -3,7 +3,7 @@ "version": "0.1.0-alpha.1", "description": "Unofficial. Not made or endorsed by NIPOST. Parse Nigerian postcodes offline.", "license": "Apache-2.0", - "homepage": "https://github.com/gatepost-dev/js/tree/main/packages/core#readme", + "homepage": "https://gatepost-dev.github.io/docs/guides/typescript/", "bugs": "https://github.com/gatepost-dev/js/issues", "repository": { "type": "git", @@ -28,9 +28,17 @@ }, "keywords": [ "nigeria", + "nipost", "postcode", + "nigeria-postcode", + "nigerian-postcode", + "postal-code", + "postcode-validation", "address", - "nipost" + "address-validation", + "digital-postcode", + "parser", + "offline" ], "size-limit": [ { diff --git a/packages/field/package.json b/packages/field/package.json index 4f88b9c..026dcbe 100644 --- a/packages/field/package.json +++ b/packages/field/package.json @@ -3,7 +3,7 @@ "version": "0.1.0-alpha.0", "description": "Unofficial. Not made or endorsed by NIPOST. A postcode field for any web form.", "license": "Apache-2.0", - "homepage": "https://github.com/gatepost-dev/js/tree/main/packages/field#readme", + "homepage": "https://gatepost-dev.github.io/docs/guides/html/", "bugs": "https://github.com/gatepost-dev/js/issues", "repository": { "type": "git", @@ -35,10 +35,17 @@ }, "keywords": [ "nigeria", + "nipost", "postcode", + "nigeria-postcode", + "nigerian-postcode", + "postal-code", + "postcode-validation", "address", - "nipost", + "address-validation", + "digital-postcode", "custom-element", + "web-component", "form" ], "size-limit": [ diff --git a/packages/react/package.json b/packages/react/package.json index f413526..f0d39e4 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -3,7 +3,7 @@ "version": "0.1.0-alpha.0", "description": "Unofficial. Not made or endorsed by NIPOST. A postcode field for React.", "license": "Apache-2.0", - "homepage": "https://github.com/gatepost-dev/js/tree/main/packages/react#readme", + "homepage": "https://gatepost-dev.github.io/docs/guides/react/", "bugs": "https://github.com/gatepost-dev/js/issues", "repository": { "type": "git", @@ -30,9 +30,15 @@ }, "keywords": [ "nigeria", + "nipost", "postcode", + "nigeria-postcode", + "nigerian-postcode", + "postal-code", + "postcode-validation", "address", - "nipost", + "address-validation", + "digital-postcode", "react", "form" ],