docs: changed homepage in package json

- Makes the homepage point to the readme file in github for each individual package instead of the demo page for better discoverability. - Fixes links to contributing guidelines.
SRGSSR · Jul 9, 2024 · 0020f92 · 0020f92
1 parent 82de85e
commit 0020f92
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 17 deletions.
diff --git a/packages/pillarbox-playlist/README.md b/packages/pillarbox-playlist/README.md
@@ -135,8 +135,8 @@ player.playlistPlugin().on('statechanged', ({ changes }) => {
 
 ## Contributing
 
-For detailed contribution guidelines, refer to the main project’s [README file][main-readme]. Please
-adhere to the specified guidelines.
+For detailed contribution guidelines, refer to our [Contributing guide][contributing-guide].
+Please adhere to the specified guidelines.
 
 ### Setting up a development server
 
@@ -171,5 +171,4 @@ http://localhost:4200/?language=fr
 This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more
 details.
 
-[main-readme]: ../../docs/README.md#Contributing
-[generate-token]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token
+[contributing-guide]: https://github.com/SRGSSR/pillarbox-web-suite/blob/main/docs/README.md#contributing
diff --git a/packages/pillarbox-playlist/package.json b/packages/pillarbox-playlist/package.json
@@ -11,7 +11,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://srgssr.github.io/pillarbox-web-suite/pillarbox-playlist",
+  "homepage": "https://github.com/SRGSSR/pillarbox-web-suite/tree/main/packages/pillarbox-playlist#readme",
   "type": "module",
   "main": "dist/pillarbox-playlist.cjs",
   "module": "dist/pillarbox-playlist.js",

diff --git a/packages/skip-button/README.md b/packages/skip-button/README.md
@@ -42,8 +42,8 @@ To apply the default styling, add the following line to your CSS file:
 
 ## Contributing
 
-For detailed contribution guidelines, refer to the main project’s [README file][main-readme]. Please
-adhere to the specified guidelines.
+For detailed contribution guidelines, refer to our [Contributing guide][contributing-guide].
+Please adhere to the specified guidelines.
 
 ### Setting up a development server
 
@@ -79,6 +79,4 @@ http://localhost:4200/?language=fr&urn=urn:rts:video:14318206
 This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more
 details.
 
-[main-readme]: ../../docs/README.md#Contributing
-
-[generate-token]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token
+[contributing-guide]: https://github.com/SRGSSR/pillarbox-web-suite/blob/main/docs/README.md#contributing
diff --git a/packages/skip-button/package.json b/packages/skip-button/package.json
@@ -11,7 +11,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://srgssr.github.io/pillarbox-web-suite/skip-button",
+  "homepage": "https://github.com/SRGSSR/pillarbox-web-suite/tree/main/packages/skip-button#readme",
   "type": "module",
   "main": "dist/skip-button.cjs",
   "module": "dist/skip-button.js",

diff --git a/scripts/template/README.md.hbs b/scripts/template/README.md.hbs
@@ -45,8 +45,8 @@ To apply the default styling, add the following line to your CSS file:
 
 ## Contributing
 
-For detailed contribution guidelines, refer to the main project’s [README file][main-readme]. Please
-adhere to the specified guidelines.
+For detailed contribution guidelines, refer to our [Contributing guide][contributing-guide].
+Please adhere to the specified guidelines.
 
 ### Setting up a development server
 
@@ -82,6 +82,4 @@ http://localhost:4200/?language=fr&urn=urn:rts:video:14318206
 This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more
 details.
 
-[main-readme]: ../../docs/README.md#Contributing
-
-[generate-token]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token
+[contributing-guide]: https://github.com/SRGSSR/pillarbox-web-suite/blob/main/docs/README.md#contributing
diff --git a/scripts/template/package.json.hbs b/scripts/template/package.json.hbs
@@ -10,7 +10,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "homepage": "https://srgssr.github.io/pillarbox-web-suite/{{kebabCase name}}",
+  "homepage": "https://github.com/SRGSSR/pillarbox-web-suite/tree/main/packages/{{kebabCase name}}#readme",
   "type": "module",
   "main": "dist/{{kebabCase name}}.cjs",
   "module": "dist/{{kebabCase name}}.js",