Docs: Set up PR preview docs

.github/workflows/deploy-docs-preview.yaml

@@ -1,46 +1,80 @@
-name: Deploy docs preview to Pages
-
-on:
-  pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - closed
-
-concurrency: preview-${{ github.ref }}
-
-defaults:
-  run:
-    working-directory: ./docs
-
-jobs:
-  # Deploy preview job
-  deploy-preview:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: npm
-          cache-dependency-path: "./docs/package-lock.json"
-      - name: Setup Pages
-        uses: actions/configure-pages@v4
-      - name: Install dependencies
-        if: github.event.action != 'closed'
-        run: npm ci
-      - name: Build with VitePress
-        if: github.event.action != 'closed'
-        run: npm run docs:build --base=/docs/preview/${{ github.event.number }}
-      - name: Deploy preview
-        uses: rossjrw/pr-preview-action@v1
-        with:
-          source-dir: docs/.vitepress/dist
-          umbrella-dir: docs/pr-preview
-          action: auto
-          token: ${{ secrets.PREVIEW_TOKEN }}
+# name: Deploy docs preview to Pages
+#
+# on:
+#   pull_request:
+#     types:
+#       - opened
+#       - reopened
+#       - synchronize
+#       - closed
+#
+# concurrency: preview-${{ github.ref }}
+#
+# defaults:
+#   run:
+#     working-directory: ./docs
+#
+# jobs:
+#   # Deploy preview job
+#   deploy-preview:
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Checkout
+#         uses: actions/checkout@v4
+#         with:
+#           fetch-depth: 0
+#
+#       - name: Setup Node
+#         uses: actions/setup-node@v4
+#         with:
+#           node-version: 20
+#           cache: npm
+#           cache-dependency-path: "./docs/package-lock.json"
+#
+#       - name: Setup Pages
+#         uses: actions/configure-pages@v4
+#       - name: Install dependencies
+#         if: github.event.action != 'closed'
+#         run: npm ci
+#
+#       - name: Build with VitePress
+#         if: github.event.action != 'closed'
+#         run: npm run docs:build --base=/dystore/previews/pr-${{ github.event.number }}/
+#
+#       - name: Upload artifact
+#         uses: actions/upload-pages-artifact@v3
+#         with:
+#           path: ./docs/.vitepress/dist
+#
+#       - name: Deploy preview
+#         id: preview-step
+#         uses: rossjrw/pr-preview-action@v1
+#         with:
+#           preview-branch: ${{ env.PREVIEW_BRANCH }}
+#           source-dir: ./docs/.vitepress/dist
+#           umbrella-dir: previews
+#           action: auto
+#           token: ${{ secrets.PREVIEW_TOKEN }}
+#           comment: false
+#
+#       - name: Comment on deploy
+#         uses: marocchino/sticky-pull-request-comment@v2
+#         if: steps.preview-step.outputs.deployment-action == 'deploy' && env.deployment_status == 'success'
+#         with:
+#           header: pr-preview
+#           message: |
+#             Documentation preview
+#             :---:
+#             | <p></p> ✅ View preview at: ${{ steps.preview-step.outputs.preview-url }} <br><br>
+#             | <h6>Built to branch [`${{ env.PREVIEW_BRANCH }}`](${{ github.server_url }}/${{ github.repository }}/tree/${{ env.PREVIEW_BRANCH }}) at ${{ steps.preview-step.outputs.action-start-time }}. <br> Preview will be ready when the [GitHub Pages deployment](${{ github.server_url }}/${{ github.repository }}/deployments) is complete. <br><br> </h6>
+#
+#       - name: Comment on removal
+#         uses: marocchino/sticky-pull-request-comment@v2
+#         if: steps.preview-step.outputs.deployment-action == 'remove' && env.deployment_status == 'success'
+#         with:
+#           header: pr-preview
+#           message: |
+#             Documentation preview
+#             :---:
+#             Preview removed because the pull request was closed.
+#             ${{ steps.preview-step.outputs.action-start-time }}

.github/workflows/deploy-docs.yaml

@@ -27,18 +27,23 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
+
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: npm
           cache-dependency-path: "./docs/package-lock.json"
+
       - name: Setup Pages
         uses: actions/configure-pages@v4
+
       - name: Install dependencies
         run: npm ci
+
       - name: Build with VitePress
-        run: npm run docs:build --base=/docs/
+        run: npm run docs:build --base=/dystore/docs/
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

docs/.vitepress/config.mts

@@ -3,8 +3,9 @@ import { defineConfig } from "vitepress";
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   lang: "en-US",
-  title: "Lunar API Documentation",
-  description: "API layer for Lunar ecommerce package",
+  title: "Dystore Documentation",
+  description:
+    "Collection of packages for ecommerce applications based on Lunar",
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [{ text: "Home", link: "/" }],
@@ -74,7 +75,7 @@ export default defineConfig({
     ],
 
     socialLinks: [
-      { icon: "github", link: "https://github.com/dystcz/lunar-api" },
+      { icon: "github", link: "https://github.com/dystcz/dystore" },
       { icon: "twitter", link: "https://twitter.com/dystcz" },
     ],
   },

docs/index.md

@@ -3,9 +3,9 @@
 layout: home
 
 hero:
-    name: "Lunar API"
+    name: "Dystore"
     text: "Documentation"
-    tagline: API layer for your Lunar application
+    tagline: Collection of packages for your Lunar application
     actions:
         - theme: brand
           text: Getting started
@@ -21,7 +21,7 @@ features:
       link: /extending/overview
     - icon: 📦
       title: Package ecosystem
-      details: Wannabe ecosystem of complementary packages with emphasis on the plug and play spirit
+      details: Ecosystem of complementary packages with emphasis on the plug and play spirit
       link: /more/compatible-packages
     - icon: 🧑‍💻
       title: Continuously developed

docs/overview.md

@@ -1,4 +1,4 @@
-# Dystore API 🪬
+# Dystore 🪬
 
 ## What's going on here?
 
@@ -12,16 +12,16 @@ easily build features to meet your project's needs.
 
 ## Some perks
 
--   Focus on extensibility
--   Wannabe ecosystem of [complementary packages](./more/compatible-packages.md)
-    with emphasis on the plug and play spirit
--   Already running in production 🤫
--   Built on top of [Laravel JSON:API](https://github.com/laravel-json-api/laravel)
+- Focus on extensibility
+- Wannabe ecosystem of [complementary packages](./more/compatible-packages.md)
+  with emphasis on the plug and play spirit
+- Already running in production 🤫
+- Built on top of [Laravel JSON:API](https://github.com/laravel-json-api/laravel)
 
 ## Features
 
--   Configurable checkout flow with guest checkout
--   Solid extensibility (Models, Schemas, Resources, Routes, ...)
--   Payment adapters registrar
-    (currently [Stripe](https://github.com/dystcz/dystore-stripe)
+- Configurable checkout flow with guest checkout
+- Solid extensibility (Models, Schemas, Resources, Routes, ...)
+- Payment adapters registrar
+  (currently [Stripe](https://github.com/dystcz/dystore-stripe)
     <!--& [Mollie](https://github.com/pixelpillow/lunar-api-mollie-adapter))-->