Update docs configuration

Author: dcvz

.github/workflows/publish-docs.yml

@@ -1,3 +1,5 @@
+# Deploys the Docusaurus docs to GitHub Pages (gh-pages branch).
+# Enable in repo: Settings → Pages → Source: Deploy from a branch → Branch: gh-pages → / (root)
 on:
   push:
     branches:
@@ -15,29 +17,22 @@ jobs:
       run:
         working-directory: docs
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16.x
+          node-version: 20
           cache: yarn
+          cache-dependency-path: docs/yarn.lock
 
       - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Build website
         run: yarn build
 
-      # Popular action to deploy to GitHub Pages:
-      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          # Build output to publish to the `gh-pages` branch:
           publish_dir: ./docs/build
-          # The following lines assign commit authorship to the official
-          # GH-Actions bot for deploys to `gh-pages` branch:
-          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
-          # The GH actions bot is used by default if you didn't specify the two fields.
-          # You can swap them out with your own user credentials.
           user_name: github-actions[bot]
           user_email: 41898282+github-actions[bot]@users.noreply.github.com

docs/README.md

@@ -24,18 +24,22 @@ $ yarn build
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-### Deployment
+### Deployment (GitHub Pages)
 
-Using SSH:
+The site is deployed to GitHub Pages via the `publish-docs` workflow on push to `main` (when `docs/**` or the workflow file change). The site is published to the `gh-pages` branch.
+
+**Repo setup:** In GitHub go to **Settings → Pages → Build and deployment**: Source = **Deploy from a branch**, Branch = **gh-pages**, Folder = **/ (root)**. The site will be available at:
+
+`https://doublesymmetry.github.io/react-native-track-player/`
+
+To deploy manually (e.g. with SSH):
 
 ```
 $ USE_SSH=true yarn deploy
 ```
 
-Not using SSH:
+Or with a Git user:
 
 ```
 $ GIT_USER=<Your GitHub username> yarn deploy
 ```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/docusaurus.config.js

@@ -8,8 +8,9 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
 const config = {
   title: 'React Native Track Player',
   tagline: 'A fully fledged audio module created for music apps',
-  url: 'https://rntp.dev',
-  baseUrl: '/',
+  // GitHub Pages project site: https://<org>.github.io/<repo>/
+  url: 'https://doublesymmetry.github.io',
+  baseUrl: '/react-native-track-player/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
   favicon: 'img/logo.png',