From 701db82e10e8b4edfdfe3648966b2dbe0c3fb008 Mon Sep 17 00:00:00 2001
From: jon r <jon@allmende.io>
Date: Thu, 24 Apr 2025 16:35:03 +0200
Subject: [PATCH] Refactor: rename app/ui-docs/ to app/docs/

---
 .gitignore                                          |   8 ++++----
 app/{ui-docs => docs}/.vitepress/config.ts          |   0
 app/{ui-docs => docs}/.vitepress/theme/Theme.vue    |   0
 app/{ui-docs => docs}/.vitepress/theme/index.ts     |   0
 app/{ui-docs => docs}/components/ui/activity.md     |   0
 app/{ui-docs => docs}/components/ui/alert.md        |   0
 app/{ui-docs => docs}/components/ui/button.md       |   0
 .../components/ui/button/options.md                 |   0
 app/{ui-docs => docs}/components/ui/button/play.md  |   0
 app/{ui-docs => docs}/components/ui/card.md         |   0
 app/{ui-docs => docs}/components/ui/heading.md      |   0
 app/{ui-docs => docs}/components/ui/input.md        |   0
 app/{ui-docs => docs}/components/ui/layout.md       |   0
 .../components/ui/layout/columns.md                 |   0
 app/{ui-docs => docs}/components/ui/layout/flex.md  |   0
 app/{ui-docs => docs}/components/ui/layout/grid.md  |   0
 .../components/ui/layout/header.md                  |   0
 .../components/ui/layout/image.png                  | Bin
 .../components/ui/layout/section.md                 |   0
 .../components/ui/layout/spacer.md                  |   0
 app/{ui-docs => docs}/components/ui/layout/stack.md |   0
 app/{ui-docs => docs}/components/ui/layout/table.md |   0
 app/{ui-docs => docs}/components/ui/link.md         |   0
 app/{ui-docs => docs}/components/ui/loader.md       |   0
 app/{ui-docs => docs}/components/ui/modal.md        |   0
 app/{ui-docs => docs}/components/ui/nav.md          |   0
 app/{ui-docs => docs}/components/ui/pagination.md   |   0
 app/{ui-docs => docs}/components/ui/pill.md         |   0
 app/{ui-docs => docs}/components/ui/pills.md        |   0
 app/{ui-docs => docs}/components/ui/popover.md      |   0
 .../components/ui/popover/image.png                 | Bin
 app/{ui-docs => docs}/components/ui/slider.md       |   0
 app/{ui-docs => docs}/components/ui/tabs.md         |   0
 app/{ui-docs => docs}/components/ui/textarea.md     |   0
 app/{ui-docs => docs}/components/ui/toc.md          |   0
 app/{ui-docs => docs}/components/ui/toggle.md       |   0
 app/{ui-docs => docs}/contributing.md               |   4 ++--
 app/{ui-docs => docs}/designing-pages.md            |   0
 app/{ui-docs => docs}/image-1.png                   | Bin
 app/{ui-docs => docs}/image.png                     | Bin
 app/{ui-docs => docs}/index.md                      |   0
 app/{ui-docs => docs}/navigation.md                 |   0
 app/{ui-docs => docs}/using-alignment.md            |   0
 app/{ui-docs => docs}/using-color.md                |   0
 app/{ui-docs => docs}/using-components.md           |   0
 app/{ui-docs => docs}/using-width.md                |   0
 app/{ui-docs => docs}/vite.config.ts                |   0
 app/package.json                                    |   8 ++++----
 app/src/components/ui/Popover.vue                   |   2 +-
 app/tsconfig.json                                   |   2 +-
 compose/docs.ui.yml                                 |   9 +++++++++
 51 files changed, 21 insertions(+), 12 deletions(-)
 rename app/{ui-docs => docs}/.vitepress/config.ts (100%)
 rename app/{ui-docs => docs}/.vitepress/theme/Theme.vue (100%)
 rename app/{ui-docs => docs}/.vitepress/theme/index.ts (100%)
 rename app/{ui-docs => docs}/components/ui/activity.md (100%)
 rename app/{ui-docs => docs}/components/ui/alert.md (100%)
 rename app/{ui-docs => docs}/components/ui/button.md (100%)
 rename app/{ui-docs => docs}/components/ui/button/options.md (100%)
 rename app/{ui-docs => docs}/components/ui/button/play.md (100%)
 rename app/{ui-docs => docs}/components/ui/card.md (100%)
 rename app/{ui-docs => docs}/components/ui/heading.md (100%)
 rename app/{ui-docs => docs}/components/ui/input.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout/columns.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout/flex.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout/grid.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout/header.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout/image.png (100%)
 rename app/{ui-docs => docs}/components/ui/layout/section.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout/spacer.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout/stack.md (100%)
 rename app/{ui-docs => docs}/components/ui/layout/table.md (100%)
 rename app/{ui-docs => docs}/components/ui/link.md (100%)
 rename app/{ui-docs => docs}/components/ui/loader.md (100%)
 rename app/{ui-docs => docs}/components/ui/modal.md (100%)
 rename app/{ui-docs => docs}/components/ui/nav.md (100%)
 rename app/{ui-docs => docs}/components/ui/pagination.md (100%)
 rename app/{ui-docs => docs}/components/ui/pill.md (100%)
 rename app/{ui-docs => docs}/components/ui/pills.md (100%)
 rename app/{ui-docs => docs}/components/ui/popover.md (100%)
 rename app/{ui-docs => docs}/components/ui/popover/image.png (100%)
 rename app/{ui-docs => docs}/components/ui/slider.md (100%)
 rename app/{ui-docs => docs}/components/ui/tabs.md (100%)
 rename app/{ui-docs => docs}/components/ui/textarea.md (100%)
 rename app/{ui-docs => docs}/components/ui/toc.md (100%)
 rename app/{ui-docs => docs}/components/ui/toggle.md (100%)
 rename app/{ui-docs => docs}/contributing.md (81%)
 rename app/{ui-docs => docs}/designing-pages.md (100%)
 rename app/{ui-docs => docs}/image-1.png (100%)
 rename app/{ui-docs => docs}/image.png (100%)
 rename app/{ui-docs => docs}/index.md (100%)
 rename app/{ui-docs => docs}/navigation.md (100%)
 rename app/{ui-docs => docs}/using-alignment.md (100%)
 rename app/{ui-docs => docs}/using-color.md (100%)
 rename app/{ui-docs => docs}/using-components.md (100%)
 rename app/{ui-docs => docs}/using-width.md (100%)
 rename app/{ui-docs => docs}/vite.config.ts (100%)

diff --git a/.gitignore b/.gitignore
index 0614449de..ae2319095 100644
--- a/.gitignore
+++ b/.gitignore
@@ -94,10 +94,10 @@ app/coverage/
 app/selenium-debug.log
 
 # Vitepress
-app/ui-docs/.vitepress/.vite
-app/ui-docs/.vitepress/cache
-app/ui-docs/.vitepress/dist
-app/ui-docs/public
+app/docs/.vitepress/.vite
+app/docs/.vitepress/cache
+app/docs/.vitepress/dist
+app/docs/public
 
 # Docs
 docs/_build
diff --git a/app/ui-docs/.vitepress/config.ts b/app/docs/.vitepress/config.ts
similarity index 100%
rename from app/ui-docs/.vitepress/config.ts
rename to app/docs/.vitepress/config.ts
diff --git a/app/ui-docs/.vitepress/theme/Theme.vue b/app/docs/.vitepress/theme/Theme.vue
similarity index 100%
rename from app/ui-docs/.vitepress/theme/Theme.vue
rename to app/docs/.vitepress/theme/Theme.vue
diff --git a/app/ui-docs/.vitepress/theme/index.ts b/app/docs/.vitepress/theme/index.ts
similarity index 100%
rename from app/ui-docs/.vitepress/theme/index.ts
rename to app/docs/.vitepress/theme/index.ts
diff --git a/app/ui-docs/components/ui/activity.md b/app/docs/components/ui/activity.md
similarity index 100%
rename from app/ui-docs/components/ui/activity.md
rename to app/docs/components/ui/activity.md
diff --git a/app/ui-docs/components/ui/alert.md b/app/docs/components/ui/alert.md
similarity index 100%
rename from app/ui-docs/components/ui/alert.md
rename to app/docs/components/ui/alert.md
diff --git a/app/ui-docs/components/ui/button.md b/app/docs/components/ui/button.md
similarity index 100%
rename from app/ui-docs/components/ui/button.md
rename to app/docs/components/ui/button.md
diff --git a/app/ui-docs/components/ui/button/options.md b/app/docs/components/ui/button/options.md
similarity index 100%
rename from app/ui-docs/components/ui/button/options.md
rename to app/docs/components/ui/button/options.md
diff --git a/app/ui-docs/components/ui/button/play.md b/app/docs/components/ui/button/play.md
similarity index 100%
rename from app/ui-docs/components/ui/button/play.md
rename to app/docs/components/ui/button/play.md
diff --git a/app/ui-docs/components/ui/card.md b/app/docs/components/ui/card.md
similarity index 100%
rename from app/ui-docs/components/ui/card.md
rename to app/docs/components/ui/card.md
diff --git a/app/ui-docs/components/ui/heading.md b/app/docs/components/ui/heading.md
similarity index 100%
rename from app/ui-docs/components/ui/heading.md
rename to app/docs/components/ui/heading.md
diff --git a/app/ui-docs/components/ui/input.md b/app/docs/components/ui/input.md
similarity index 100%
rename from app/ui-docs/components/ui/input.md
rename to app/docs/components/ui/input.md
diff --git a/app/ui-docs/components/ui/layout.md b/app/docs/components/ui/layout.md
similarity index 100%
rename from app/ui-docs/components/ui/layout.md
rename to app/docs/components/ui/layout.md
diff --git a/app/ui-docs/components/ui/layout/columns.md b/app/docs/components/ui/layout/columns.md
similarity index 100%
rename from app/ui-docs/components/ui/layout/columns.md
rename to app/docs/components/ui/layout/columns.md
diff --git a/app/ui-docs/components/ui/layout/flex.md b/app/docs/components/ui/layout/flex.md
similarity index 100%
rename from app/ui-docs/components/ui/layout/flex.md
rename to app/docs/components/ui/layout/flex.md
diff --git a/app/ui-docs/components/ui/layout/grid.md b/app/docs/components/ui/layout/grid.md
similarity index 100%
rename from app/ui-docs/components/ui/layout/grid.md
rename to app/docs/components/ui/layout/grid.md
diff --git a/app/ui-docs/components/ui/layout/header.md b/app/docs/components/ui/layout/header.md
similarity index 100%
rename from app/ui-docs/components/ui/layout/header.md
rename to app/docs/components/ui/layout/header.md
diff --git a/app/ui-docs/components/ui/layout/image.png b/app/docs/components/ui/layout/image.png
similarity index 100%
rename from app/ui-docs/components/ui/layout/image.png
rename to app/docs/components/ui/layout/image.png
diff --git a/app/ui-docs/components/ui/layout/section.md b/app/docs/components/ui/layout/section.md
similarity index 100%
rename from app/ui-docs/components/ui/layout/section.md
rename to app/docs/components/ui/layout/section.md
diff --git a/app/ui-docs/components/ui/layout/spacer.md b/app/docs/components/ui/layout/spacer.md
similarity index 100%
rename from app/ui-docs/components/ui/layout/spacer.md
rename to app/docs/components/ui/layout/spacer.md
diff --git a/app/ui-docs/components/ui/layout/stack.md b/app/docs/components/ui/layout/stack.md
similarity index 100%
rename from app/ui-docs/components/ui/layout/stack.md
rename to app/docs/components/ui/layout/stack.md
diff --git a/app/ui-docs/components/ui/layout/table.md b/app/docs/components/ui/layout/table.md
similarity index 100%
rename from app/ui-docs/components/ui/layout/table.md
rename to app/docs/components/ui/layout/table.md
diff --git a/app/ui-docs/components/ui/link.md b/app/docs/components/ui/link.md
similarity index 100%
rename from app/ui-docs/components/ui/link.md
rename to app/docs/components/ui/link.md
diff --git a/app/ui-docs/components/ui/loader.md b/app/docs/components/ui/loader.md
similarity index 100%
rename from app/ui-docs/components/ui/loader.md
rename to app/docs/components/ui/loader.md
diff --git a/app/ui-docs/components/ui/modal.md b/app/docs/components/ui/modal.md
similarity index 100%
rename from app/ui-docs/components/ui/modal.md
rename to app/docs/components/ui/modal.md
diff --git a/app/ui-docs/components/ui/nav.md b/app/docs/components/ui/nav.md
similarity index 100%
rename from app/ui-docs/components/ui/nav.md
rename to app/docs/components/ui/nav.md
diff --git a/app/ui-docs/components/ui/pagination.md b/app/docs/components/ui/pagination.md
similarity index 100%
rename from app/ui-docs/components/ui/pagination.md
rename to app/docs/components/ui/pagination.md
diff --git a/app/ui-docs/components/ui/pill.md b/app/docs/components/ui/pill.md
similarity index 100%
rename from app/ui-docs/components/ui/pill.md
rename to app/docs/components/ui/pill.md
diff --git a/app/ui-docs/components/ui/pills.md b/app/docs/components/ui/pills.md
similarity index 100%
rename from app/ui-docs/components/ui/pills.md
rename to app/docs/components/ui/pills.md
diff --git a/app/ui-docs/components/ui/popover.md b/app/docs/components/ui/popover.md
similarity index 100%
rename from app/ui-docs/components/ui/popover.md
rename to app/docs/components/ui/popover.md
diff --git a/app/ui-docs/components/ui/popover/image.png b/app/docs/components/ui/popover/image.png
similarity index 100%
rename from app/ui-docs/components/ui/popover/image.png
rename to app/docs/components/ui/popover/image.png
diff --git a/app/ui-docs/components/ui/slider.md b/app/docs/components/ui/slider.md
similarity index 100%
rename from app/ui-docs/components/ui/slider.md
rename to app/docs/components/ui/slider.md
diff --git a/app/ui-docs/components/ui/tabs.md b/app/docs/components/ui/tabs.md
similarity index 100%
rename from app/ui-docs/components/ui/tabs.md
rename to app/docs/components/ui/tabs.md
diff --git a/app/ui-docs/components/ui/textarea.md b/app/docs/components/ui/textarea.md
similarity index 100%
rename from app/ui-docs/components/ui/textarea.md
rename to app/docs/components/ui/textarea.md
diff --git a/app/ui-docs/components/ui/toc.md b/app/docs/components/ui/toc.md
similarity index 100%
rename from app/ui-docs/components/ui/toc.md
rename to app/docs/components/ui/toc.md
diff --git a/app/ui-docs/components/ui/toggle.md b/app/docs/components/ui/toggle.md
similarity index 100%
rename from app/ui-docs/components/ui/toggle.md
rename to app/docs/components/ui/toggle.md
diff --git a/app/ui-docs/contributing.md b/app/docs/contributing.md
similarity index 81%
rename from app/ui-docs/contributing.md
rename to app/docs/contributing.md
index 8fc733e89..4104c23cd 100644
--- a/app/ui-docs/contributing.md
+++ b/app/docs/contributing.md
@@ -25,7 +25,7 @@ docs](https://vitepress.dev/guide/using-vue#vs-code-intellisense-support):
 :::
 
 1. Create a file `Xyz.vue` at `src/components/ui` and code the component
-2. Add a file `xyz.md` at `ui-docs/components` with exhaustive examples
-3. In `ui-docs/.vitepress/config.ts`, add the component to the sidebar links
+2. Add a file `xyz.md` at `docs/components` with exhaustive examples
+3. In `docs/.vitepress/config.ts`, add the component to the sidebar links
 
 Make sure to follow the [anatomy of a Component](./using-components#anatomy-of-a-component-file)!
diff --git a/app/ui-docs/designing-pages.md b/app/docs/designing-pages.md
similarity index 100%
rename from app/ui-docs/designing-pages.md
rename to app/docs/designing-pages.md
diff --git a/app/ui-docs/image-1.png b/app/docs/image-1.png
similarity index 100%
rename from app/ui-docs/image-1.png
rename to app/docs/image-1.png
diff --git a/app/ui-docs/image.png b/app/docs/image.png
similarity index 100%
rename from app/ui-docs/image.png
rename to app/docs/image.png
diff --git a/app/ui-docs/index.md b/app/docs/index.md
similarity index 100%
rename from app/ui-docs/index.md
rename to app/docs/index.md
diff --git a/app/ui-docs/navigation.md b/app/docs/navigation.md
similarity index 100%
rename from app/ui-docs/navigation.md
rename to app/docs/navigation.md
diff --git a/app/ui-docs/using-alignment.md b/app/docs/using-alignment.md
similarity index 100%
rename from app/ui-docs/using-alignment.md
rename to app/docs/using-alignment.md
diff --git a/app/ui-docs/using-color.md b/app/docs/using-color.md
similarity index 100%
rename from app/ui-docs/using-color.md
rename to app/docs/using-color.md
diff --git a/app/ui-docs/using-components.md b/app/docs/using-components.md
similarity index 100%
rename from app/ui-docs/using-components.md
rename to app/docs/using-components.md
diff --git a/app/ui-docs/using-width.md b/app/docs/using-width.md
similarity index 100%
rename from app/ui-docs/using-width.md
rename to app/docs/using-width.md
diff --git a/app/ui-docs/vite.config.ts b/app/docs/vite.config.ts
similarity index 100%
rename from app/ui-docs/vite.config.ts
rename to app/docs/vite.config.ts
diff --git a/app/package.json b/app/package.json
index 938f13212..6235ae468 100644
--- a/app/package.json
+++ b/app/package.json
@@ -7,17 +7,17 @@
   "author": "Funkwhale Collective <contact@funkwhale.audio>",
   "scripts": {
     "dev": "vite",
-    "dev:docs": "VP_DOCS=true vitepress dev ui-docs",
+    "dev:docs": "VP_DOCS=true vitepress dev docs",
     "build": "vite build --mode development",
     "build:deployment": "vite build",
-    "build:docs": "VP_DOCS=true vitepress build ui-docs",
-    "serve:docs": "VP_DOCS=true vitepress serve ui-docs",
+    "build:docs": "VP_DOCS=true vitepress build docs",
+    "serve:docs": "VP_DOCS=true vitepress serve docs",
     "serve": "vite preview",
     "test": "vitest run",
     "test:unit": "vitest run --coverage",
     "test:generate-mock-server": "msw-auto-mock ../docs/schema.yml -o test/msw-server.ts --node",
     "lint": "yarn lint:es && yarn lint:tsc",
-    "lint:es": "eslint --max-warnings 0 --cache --cache-strategy content --ext .ts,.js,.vue,.json,.html,.cjs . cypress public/embed.html src test ui-docs",
+    "lint:es": "eslint --max-warnings 0 --cache --cache-strategy content --ext .ts,.js,.vue,.json,.html,.cjs . cypress public/embed.html src test docs",
     "lint:tsc": "vue-tsc --noEmit --incremental && tsc --noEmit --incremental --project tsconfig.json",
     "generate-types-from-local-schema": "yarn run openapi-typescript ../api/funkwhale_api/common/schema.yml -o src/generated/types.ts",
     "generate-types-from-remote-schema": "yarn run openapi-typescript https://docs.funkwhale.audio/develop/swagger/schema.yml -o src/generated/types.ts",
diff --git a/app/src/components/ui/Popover.vue b/app/src/components/ui/Popover.vue
index f345f6042..6366d66f1 100644
--- a/app/src/components/ui/Popover.vue
+++ b/app/src/components/ui/Popover.vue
@@ -8,7 +8,7 @@ import { type ColorProps, type DefaultProps, type RaisedProps, color } from '~/c
 
 /* TODO: Basic accessibility
 
--> See ui-docs
+-> See docs/
 
 */
 
diff --git a/app/tsconfig.json b/app/tsconfig.json
index 4f203a357..29a171117 100644
--- a/app/tsconfig.json
+++ b/app/tsconfig.json
@@ -27,7 +27,7 @@
     "test/**/*.ts",
     "src/docs/vite.config.ts",
     "src/docs/**/*.ts",
-    "ui-docs/**/*.md"
+    "docs/**/*.md"
   ],
   "vueCompilerOptions": {
     "vitePressExtensions": [".md"],
diff --git a/compose/docs.ui.yml b/compose/docs.ui.yml
index 54b29e1d4..168d6b8cf 100644
--- a/compose/docs.ui.yml
+++ b/compose/docs.ui.yml
@@ -2,6 +2,7 @@ services:
   ui:
     build:
       context: ../app
+      # The documentation of the UI component library lives within the same NPM package as the Funkwhale app, why we use its container.
       dockerfile: Dockerfile.dev
     command: yarn dev:docs --host 0.0.0.0
     expose: ['5173']
@@ -11,6 +12,14 @@ services:
       - '../app:/app'
       - '/app/node_modules'
     networks: ['web']
+    # We need to overwrite the healthcheck, since the Docker image is actually scoped for running the UI.
+    healthcheck:
+      # And we need to talk IPv4, as the busybox prefers IPv6, fails and  doesn't fall back to IPv4 for tryping again.
+      test: ['CMD-SHELL', 'wget --no-verbose --tries=1 --spider http://127.0.0.1:5173/ || exit 1']
+      interval: 10s
+      timeout: 5s
+      retries: 3
+      start_period: 30s
     labels:
       - 'traefik.enable=true'
       - 'traefik.http.routers.test-funkwhale-ui-web.rule=Host(`ui.funkwhale.test`)'