From eb8a26d47ce2f53610f7b4b07713698322aa864d Mon Sep 17 00:00:00 2001 From: "Timothy J. Baek" Date: Wed, 25 Sep 2024 01:49:34 +0200 Subject: [PATCH] refac --- docs/features.mdx | 2 +- docs/getting-started/{swagger.md => api.md} | 8 +++++++- docs/getting-started/env-configuration.md | 6 +++++- docs/getting-started/index.mdx | 2 +- docs/getting-started/installation.md | 5 ++++- docs/getting-started/logging.md | 5 ++++- docs/getting-started/updating.md | 5 ++++- docs/pipelines/_category_.json | 4 ++++ docs/pipelines/index.mdx | 5 ----- docs/troubleshooting/index.mdx | 2 +- 10 files changed, 31 insertions(+), 13 deletions(-) rename docs/getting-started/{swagger.md => api.md} (70%) create mode 100644 docs/pipelines/_category_.json diff --git a/docs/features.mdx b/docs/features.mdx index 4f76855..28cd23c 100644 --- a/docs/features.mdx +++ b/docs/features.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 2 title: "⭐ Features" --- diff --git a/docs/getting-started/swagger.md b/docs/getting-started/api.md similarity index 70% rename from docs/getting-started/swagger.md rename to docs/getting-started/api.md index 5589e48..f34f45c 100644 --- a/docs/getting-started/swagger.md +++ b/docs/getting-started/api.md @@ -1,7 +1,13 @@ -# Swagger Docs +--- +sidebar_position: 5 +title: "Open WebUI API Endpoints" +--- + +## Swagger Docs | App | Docs Path | |----------|---------------------| + | Main | /docs | | WebUI | /api/v1/docs | | Ollama | /ollama/docs | | OpenAI | /openai/docs | diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 4107c6b..7c11169 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -1,4 +1,8 @@ -# Environment Variable Configuration +--- +sidebar_position: 4 +title: "Environment Variable Configuration" +--- + ## Overview diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 5974dd4..e21a7b9 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 3 title: "🚀 Getting Started" --- diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 6115034..9ee3620 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,4 +1,7 @@ -# Alternative Installation +--- +sidebar_position: 1 +title: "Alternative Installation" +--- ### Installing Both Ollama and Open WebUI Using Kustomize diff --git a/docs/getting-started/logging.md b/docs/getting-started/logging.md index d75d9e9..4623a17 100644 --- a/docs/getting-started/logging.md +++ b/docs/getting-started/logging.md @@ -1,4 +1,7 @@ -# Logging +--- +sidebar_position: 3 +title: "Open WebUI Logging" +--- ## Browser Client Logging ## diff --git a/docs/getting-started/updating.md b/docs/getting-started/updating.md index 31531f2..c96b95b 100644 --- a/docs/getting-started/updating.md +++ b/docs/getting-started/updating.md @@ -1,4 +1,7 @@ -# Updating +--- +sidebar_position: 2 +title: "Updating Open WebUI" +--- ## Updating your Docker Installation diff --git a/docs/pipelines/_category_.json b/docs/pipelines/_category_.json new file mode 100644 index 0000000..5e0e3e5 --- /dev/null +++ b/docs/pipelines/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "⚡ Pipelines", + "position": 700 +} \ No newline at end of file diff --git a/docs/pipelines/index.mdx b/docs/pipelines/index.mdx index 4b7456d..b2772c2 100644 --- a/docs/pipelines/index.mdx +++ b/docs/pipelines/index.mdx @@ -1,8 +1,3 @@ ---- -sidebar_position: 1 -title: "⚡ Pipelines" ---- - import { TopBanners } from "@site/src/components/TopBanners"; diff --git a/docs/troubleshooting/index.mdx b/docs/troubleshooting/index.mdx index 6c84d44..21caec9 100644 --- a/docs/troubleshooting/index.mdx +++ b/docs/troubleshooting/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 400 +sidebar_position: 300 title: "🛠️ Troubleshooting" ---