Fixed docs deployment.

.github/workflows/test-docs.yml

@@ -3,6 +3,7 @@ name: Test Docs
 on:
   pull_request:
     branches:
+      - 'main'
       - 'feature/**'
 
 jobs:
@@ -22,6 +23,10 @@ jobs:
         run: npm install
         working-directory: '${{ github.workspace }}/docs'
 
+      - name: Build documentation site
+        run: npm run build
+        working-directory: '${{ github.workspace }}/docs'
+
       - name: Run tests
         run: npm run test
         working-directory: '${{ github.workspace }}/docs'

docs/docs/documentation.mdx

@@ -17,9 +17,25 @@ own project.
 The [configuration file](https://github.com/AlexSkrypnyk/scaffold/blob/main/docs/docusaurus.config.js)
 allows to adjust the documentation to your needs.
 
-## Publishing
+## Publishing to Netlify on pull requests
 
-Documentation is published to GitHub Pages using
+Documentation is published to Netlify on every pull request using
+the [Deploy Docs to GitHub Pages](https://github.com/AlexSkrypnyk/scaffold/blob/main/.github/workflows/docs.yml)
+GitHub Action.
+
+Deployed documentation link will be added to the pull request as a comment.
+
+### Netlify configuration
+
+Set up a new site on Netlify and add the following environment variables
+to the `Secrets and variables > Actions > Repository secrets` in GitHub settings:
+
+- `NETLIFY_SITE_ID` - `Site > Site configuration > General > Site details > Site information > Site ID`
+- `NETLIFY_AUTH_TOKEN` - `User settings > Applications > Personal access tokens > New access token`
+
+## Publishing to GitHub pages on release
+
+Documentation is published to GitHub Pages on release (tag) using
 the [Deploy Docs to GitHub Pages](https://github.com/AlexSkrypnyk/scaffold/blob/main/.github/workflows/docs.yml)
 GitHub Action.
 

docs/docusaurus.config.js

@@ -81,7 +81,7 @@ const config = {
   /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
       // Replace with your project's social card
-      image: 'img/scaffold-social-card.jpg',
+      image: 'img/social-card.jpg',
       navbar: {
         logo: {
           alt: 'Scaffold Logo',

docs/package.json

@@ -10,7 +10,8 @@
     "clear": "docusaurus clear",
     "serve": "docusaurus serve",
     "write-translations": "docusaurus write-translations",
-    "write-heading-ids": "docusaurus write-heading-ids"
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "test": "echo Would run docs tests"
   },
   "dependencies": {
     "@docusaurus/core": "3.1.1",