open-webui/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2026-08-24 06:23:58 -04:00
Code Issues 37 Packages Projects Releases Wiki Activity

[PR #266] [MERGED] Overhaul of Getting Started Guide and Documentation Structure #355

New Issue
Closed
opened 2026-02-15 17:16:32 -05:00 by yindo · 0 comments
yindo commented 2026-02-15 17:16:32 -05:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/266
Author: @matthewhand
Created: 11/5/2024
Status: ✅ Merged
Merged: 11/5/2024
Merged by: @tjbck

Base: main ← Head: getting-started

📝 Commits (10+)

  • 49e570d fix: Apply Prettier formatting to docusaurus.config.ts to fix CI
  • 361d992 Merge branch 'open-webui:main' into main
  • 971a8a9 Merge branch 'open-webui:main' into main
  • 9933722 Add Development.md changes from feature-nginx-combined
  • 24e2e61 Add EnvConfig.md changes from feature-nginx-combined
  • 26d1636 Add HttpsEncryption.md changes from feature-nginx-combined
  • 837386c Add Logging.md changes from feature-nginx-combined
  • 3b784a3 Add advanced-topics/index.mdx changes from feature-nginx-combined
  • 3bfd410 Add index.md changes from feature-nginx-combined
  • 73fc065 Add quick-start/index.mdx changes from feature-nginx-combined

📊 Changes

34 files changed (+1309 additions, -1007 deletions)

View changed files

📝 .github/workflows/gh-pages.yml (+54 -54)
📝 docs/getting-started/advanced-topics/api-endpoints.md (+0 -0)
➕ docs/getting-started/advanced-topics/development.md (+201 -0)
📝 docs/getting-started/advanced-topics/env-configuration.md (+1 -1)
➕ docs/getting-started/advanced-topics/https-encryption.md (+27 -0)
➕ docs/getting-started/advanced-topics/index.mdx (+43 -0)
📝 docs/getting-started/advanced-topics/logging.md (+1 -1)
➖ docs/getting-started/development.mdx (+0 -199)
➕ docs/getting-started/index.md (+27 -0)
➖ docs/getting-started/index.mdx (+0 -585)
➖ docs/getting-started/installation.md (+0 -40)
➕ docs/getting-started/quick-start/index.mdx (+155 -0)
➕ docs/getting-started/quick-start/tab-docker/DataStorage.md (+12 -0)
➕ docs/getting-started/quick-start/tab-docker/DockerCompose.md (+54 -0)
➕ docs/getting-started/quick-start/tab-docker/DockerSwarm.md (+141 -0)
➕ docs/getting-started/quick-start/tab-docker/DockerUpdating.md (+42 -0)
➕ docs/getting-started/quick-start/tab-docker/ManualDocker.md (+24 -0)
➕ docs/getting-started/quick-start/tab-docker/Podman.md (+28 -0)
➕ docs/getting-started/quick-start/tab-kubernetes/Helm.md (+34 -0)
➕ docs/getting-started/quick-start/tab-kubernetes/Kustomize.md (+35 -0)

...and 14 more files

���� Description

Restructure and Optimize Getting Started Guide

This PR enhances the organization and accessibility of Open WebUI’s documentation. Key improvements include:

  • Restructured Getting Started Guide: Simplified and organized the onboarding process for improved flow.
  • Consolidated Installation Methods: Grouped installation instructions into tabs (tab-docker, tab-kubernetes, tab-python) to make setup options clear and accessible.
  • Next Steps Section: Added guidance on terminology, resources, and common troubleshooting for Ollama setup, supporting new users post-installation.
  • Advanced Topics Relocation: Moved advanced configuration guides (e.g., development, env-configuration, logging) into advanced-topics/ for a cleaner structure.
  • Fixed Broken Links: Resolved broken links in intro and ipex_llm tutorial, ensuring all resources correctly point to updated sections.

Directory Overview:
The reorganization reflects in the docs/ structure:

docs/
├── contributing.mdx
├── faq.mdx
├── features.mdx
├── getting-started
│   ├── advanced-topics
│   │   ├── api-endpoints.md
│   │   ├── development.md
│   │   ├── env-configuration.md
│   │   ├── https-encryption.md
│   │   ├── index.mdx
│   │   └── logging.md
│   ├── index.md
│   ├── quick-start
│   │   ├── index.mdx
│   │   ├── tab-docker
│   │   │   ├── DataStorage.md
│   │   │   ├── DockerCompose.md
│   │   │   ├── DockerSwarm.md
│   │   │   ├── DockerUpdating.md
│   │   │   ├── ManualDocker.md
│   │   │   └── Podman.md
│   │   ├── tab-kubernetes
│   │   │   ├── Helm.md
│   │   │   └── Kustomize.md
│   │   └── tab-python
│   │       ├── CondaUnix.md
│   │       ├── CondaWindows.md
│   │       └── Venv.md
│   └── using-openwebui
│       ├── index.mdx
│       ├── resources.mdx
│       ├── tab-ollama
│       │   ├── OllamaDocker.md
│       │   └── OllamaRemote.md
│       ├── terminology.mdx
│       └── troubleshooting-ollama.mdx
└── intro.mdx

These changes align with the project’s contribution guidelines by providing a more intuitive, organized, and accessible documentation structure.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/266 **Author:** [@matthewhand](https://github.com/matthewhand) **Created:** 11/5/2024 **Status:** ✅ Merged **Merged:** 11/5/2024 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `main` ← **Head:** `getting-started` --- ### 📝 Commits (10+) - [`49e570d`](https://github.com/open-webui/docs/commit/49e570d1f2165a63a57e12429184abe83740f6b5) fix: Apply Prettier formatting to docusaurus.config.ts to fix CI - [`361d992`](https://github.com/open-webui/docs/commit/361d992075963b6e1ef82671c126327b15d8e62c) Merge branch 'open-webui:main' into main - [`971a8a9`](https://github.com/open-webui/docs/commit/971a8a977e0bc0b1e05e368328521318e53a47f5) Merge branch 'open-webui:main' into main - [`9933722`](https://github.com/open-webui/docs/commit/99337223336bc255f78e481e31e3cf124c0376b9) Add Development.md changes from feature-nginx-combined - [`24e2e61`](https://github.com/open-webui/docs/commit/24e2e61e55b2b2ed8ce7b9c63a3cd3611fdb0d16) Add EnvConfig.md changes from feature-nginx-combined - [`26d1636`](https://github.com/open-webui/docs/commit/26d16362dd134d0083b805d1bdd0ac80abcfe4ec) Add HttpsEncryption.md changes from feature-nginx-combined - [`837386c`](https://github.com/open-webui/docs/commit/837386c1ac81e52dd37a273f009146c0b7dfe035) Add Logging.md changes from feature-nginx-combined - [`3b784a3`](https://github.com/open-webui/docs/commit/3b784a3b3d5bb53f3b09625b5cc2ac97ab2516ea) Add advanced-topics/index.mdx changes from feature-nginx-combined - [`3bfd410`](https://github.com/open-webui/docs/commit/3bfd4104270c12f98e8c0197fe8092790063515c) Add index.md changes from feature-nginx-combined - [`73fc065`](https://github.com/open-webui/docs/commit/73fc0651d24d09d4721460c8420b36cb2f4b9242) Add quick-start/index.mdx changes from feature-nginx-combined ### 📊 Changes **34 files changed** (+1309 additions, -1007 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/gh-pages.yml` (+54 -54) 📝 `docs/getting-started/advanced-topics/api-endpoints.md` (+0 -0) ➕ `docs/getting-started/advanced-topics/development.md` (+201 -0) 📝 `docs/getting-started/advanced-topics/env-configuration.md` (+1 -1) ➕ `docs/getting-started/advanced-topics/https-encryption.md` (+27 -0) ➕ `docs/getting-started/advanced-topics/index.mdx` (+43 -0) 📝 `docs/getting-started/advanced-topics/logging.md` (+1 -1) ➖ `docs/getting-started/development.mdx` (+0 -199) ➕ `docs/getting-started/index.md` (+27 -0) ➖ `docs/getting-started/index.mdx` (+0 -585) ➖ `docs/getting-started/installation.md` (+0 -40) ➕ `docs/getting-started/quick-start/index.mdx` (+155 -0) ➕ `docs/getting-started/quick-start/tab-docker/DataStorage.md` (+12 -0) ➕ `docs/getting-started/quick-start/tab-docker/DockerCompose.md` (+54 -0) ➕ `docs/getting-started/quick-start/tab-docker/DockerSwarm.md` (+141 -0) ➕ `docs/getting-started/quick-start/tab-docker/DockerUpdating.md` (+42 -0) ➕ `docs/getting-started/quick-start/tab-docker/ManualDocker.md` (+24 -0) ➕ `docs/getting-started/quick-start/tab-docker/Podman.md` (+28 -0) ➕ `docs/getting-started/quick-start/tab-kubernetes/Helm.md` (+34 -0) ➕ `docs/getting-started/quick-start/tab-kubernetes/Kustomize.md` (+35 -0) _...and 14 more files_ </details> ### ���� Description ### Restructure and Optimize Getting Started Guide This PR enhances the organization and accessibility of Open WebUI’s documentation. Key improvements include: - **Restructured Getting Started Guide**: Simplified and organized the onboarding process for improved flow. - **Consolidated Installation Methods**: Grouped installation instructions into tabs (`tab-docker`, `tab-kubernetes`, `tab-python`) to make setup options clear and accessible. - **Next Steps Section**: Added guidance on terminology, resources, and common troubleshooting for Ollama setup, supporting new users post-installation. - **Advanced Topics Relocation**: Moved advanced configuration guides (e.g., `development`, `env-configuration`, `logging`) into `advanced-topics/` for a cleaner structure. - **Fixed Broken Links**: Resolved broken links in intro and ipex_llm tutorial, ensuring all resources correctly point to updated sections. --- **Directory Overview**: The reorganization reflects in the `docs/` structure: ``` docs/ ├── contributing.mdx ├── faq.mdx ├── features.mdx ├── getting-started │ ├── advanced-topics │ │ ├── api-endpoints.md │ │ ├── development.md │ │ ├── env-configuration.md │ │ ├── https-encryption.md │ │ ├── index.mdx │ │ └── logging.md │ ├── index.md │ ├── quick-start │ │ ├── index.mdx │ │ ├── tab-docker │ │ │ ├── DataStorage.md │ │ │ ├── DockerCompose.md │ │ │ ├── DockerSwarm.md │ │ │ ├── DockerUpdating.md │ │ │ ├── ManualDocker.md │ │ │ └── Podman.md │ │ ├── tab-kubernetes │ │ │ ├── Helm.md │ │ │ └── Kustomize.md │ │ └── tab-python │ │ ├── CondaUnix.md │ │ ├── CondaWindows.md │ │ └── Venv.md │ └── using-openwebui │ ├── index.mdx │ ├── resources.mdx │ ├── tab-ollama │ │ ├── OllamaDocker.md │ │ └── OllamaRemote.md │ ├── terminology.mdx │ └── troubleshooting-ollama.mdx └── intro.mdx ``` These changes align with the project’s contribution guidelines by providing a more intuitive, organized, and accessible documentation structure. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-15 17:16:32 -05:00
yindo closed this issue 2026-02-15 17:16:32 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
documentation
documentation
duplicate
enhancement
enhancement
good first issue
good first issue
good first issue
help wanted
pull-request
Mirrored from GitHub Pull Request
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: open-webui/docs#355
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?