Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs(deployment): remove RAUX/Open-WebUI references from docs#931

Merged
itomek merged 1 commit into
mainfrom
929-remove-raux-references-docs
Apr 30, 2026
Merged

docs(deployment): remove RAUX/Open-WebUI references from docs#931
itomek merged 1 commit into
mainfrom
929-remove-raux-references-docs

Conversation

@itomek

@itomek itomek commented Apr 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

Removes all references to RAUX (the retired Open-WebUI fork) from the documentation. RAUX is no longer part of GAIA; the current UI is the Gaia Agent UI (src/gaia/apps/webui/ + src/gaia/ui/).

Why

docs/deployment/ui.mdx still contained a full "GAIA UI (RAUX) Interface" section, including an acknowledgment block for the OpenWebUI team and a link to the retired aigdat/raux repository. Three other doc files used the bare "GAIA UI" label (which pointed contributors toward the wrong product). These references misdirect external contributors and are factually wrong.

Refs #929

Changes

  • docs/deployment/ui.mdx — removed the "GAIA UI (RAUX) Interface" section entirely; renamed "GAIA Chat (Lightweight Desktop)" → "Gaia Agent UI Architecture" and removed the "lighter alternative to RAUX" framing; updated Developer Quick Start link text.
  • docs/guides/custom-agent.mdx — "GAIA UI" → "Gaia Agent UI" (line 13).
  • docs/plans/axis-gaia-integration.md — "GAIA UI" → "Gaia Agent UI" (line 162).
  • docs/plans/desktop-installer.mdx — "GAIA UI" → "Gaia Agent UI" (line 419).

Must land before PR 3 (the stale-strings CI workflow), which enforces the absence of these terms going forward.

Test plan

  • grep -rn -i "raux\|open-webui\|openwebui" docs/ — zero hits
  • grep -rn "GAIA UI" docs/ (without "Agent") — zero hits
  • All internal links in docs/deployment/ui.mdx resolve: /guides/agent-ui, /sdk/sdks/agent-ui, /spec/agent-ui-server, /reference/troubleshooting#appimage-on-linux

Checklist

  • I have linked a GitHub issue above (Refs #929).
  • I have described why this change is being made, not just what changed.
  • No code changes — docs only; lint and unit tests are not applicable.
  • Documentation updated (this PR is the documentation update).

@itomek
docs(deployment): remove RAUX/Open-WebUI references, update ui.mdx
4208163 
RAUX (the Open-WebUI fork) is no longer part of GAIA. This commit
removes the stale "GAIA UI (RAUX) Interface" section from ui.mdx,
rewrites the architecture section to describe the current Gaia Agent UI
(FastAPI + React/TS/Vite/Electron), and renames bare "GAIA UI" →
"Gaia Agent UI" in three other doc files.

Refs #929
@itomek itomek requested a review from kovtcharov-amd as a code owner April 30, 2026 19:01
@github-actions github-actions Bot added the documentation Documentation changes label Apr 30, 2026
@itomek itomek linked an issue Apr 30, 2026 that may be closed by this pull request
Streamline contributor onboarding: refresh templates, contributing guide, remove RAUX references, and prevent regression #929
Closed
7 tasks
@itomek itomek self-assigned this Apr 30, 2026
@github-actions

github-actions Bot commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Docs-only PR that removes the retired "GAIA UI (RAUX)" section from docs/deployment/ui.mdx (including the OpenWebUI acknowledgments and the dead aigdat/raux link), and replaces three stray "GAIA UI" mentions in three other docs with "Gaia Agent UI". The PR's three test-plan checks all pass on the head: grep -i "raux\|open-webui\|openwebui" docs/ → 0 hits, grep "GAIA UI" docs/ (without "Agent") → 0 hits, and the four internal links in docs/deployment/ui.mdx (/guides/agent-ui, /sdk/sdks/agent-ui, /spec/agent-ui-server, /reference/troubleshooting#appimage-on-linux) all resolve to existing files / headings. The single thing worth fixing before merge is the casing of the new product name — this PR introduces "Gaia Agent UI" while the rest of the docs corpus uses "GAIA Agent UI".

Issues Found

🟡 Important

Casing inconsistency: "Gaia Agent UI" vs the established "GAIA Agent UI" (docs/deployment/ui.mdx:113,115,129,158, docs/guides/custom-agent.mdx:13, docs/plans/axis-gaia-integration.md:162, docs/plans/desktop-installer.mdx:419)

Across the rest of the docs the product is consistently styled "GAIA Agent UI" — 37 occurrences across 19 files, including in the same files this PR modifies:

  • docs/deployment/ui.mdx — keeps the existing "GAIA Agent UI" on lines 12 and 43, but the new lines 113/115/129/158 introduce "Gaia Agent UI" → mixed within one page.
  • docs/guides/custom-agent.mdx — the frontmatter on line 3 (description: "Create your own AI agents and add them to the GAIA Agent UI") keeps "GAIA Agent UI" while the body text on line 13 now says "Gaia Agent UI".
  • docs/plans/desktop-installer.mdx — five existing "GAIA Agent UI" occurrences (lines 3, 28, 224, 396, 519) vs one new "Gaia Agent UI" on line 419.

Since the description mentions "PR 3 (the stale-strings CI workflow), which enforces the absence of these terms going forward", a casing decision now will save churn later. If the canonical form is GAIA Agent UI (matches GAIA = Generative AI Is Awesome and the productName: "GAIA Agent UI" in the electron-builder block at docs/plans/desktop-installer.mdx:396), the suggestions below align this PR with that. If the intent is actually to switch to Gaia Agent UI site-wide, that's a wider rename and worth raising with @kovtcharov-amd before this lands so the stale-strings workflow can encode the right canonical form.

Pick one example — applied here on the most visible site, the new H1 in docs/deployment/ui.mdx:113:

# GAIA Agent UI Architecture

The GAIA Agent UI is a privacy-first desktop chat application built with a Python FastAPI backend and a React/TypeScript frontend, packaged as an Electron desktop app.

…and apply the same Gaia Agent UI → GAIA Agent UI substitution at the other six spots listed above (the ASCII diagram at docs/deployment/ui.mdx:129, the "Gaia Agent UI Guide" link text at :158, plus the three sibling files).

🟢 Minor — out of scope, follow-up

Stale "GAIA Chat" / "GAIA Chat Desktop" references (not changed by this PR; flagged for visibility)

This PR renames the heading "GAIA Chat (Lightweight Desktop)" → "Gaia Agent UI Architecture" in docs/deployment/ui.mdx, but other docs still call the same product "GAIA Chat":

  • docs/guides/chat.mdx:12 — [GAIA Chat Desktop](/guides/agent-ui)
  • docs/guides/chat.mdx:299 — Card title "GAIA Chat Desktop"
  • docs/spec/agent-ui-server.mdx:24 — "powers the GAIA Chat desktop application"
  • docs/sdk/sdks/chat.mdx:352 — [GAIA Chat Desktop](/guides/agent-ui)
  • docs/plans/autonomy-engine.mdx:236 — "open GAIA Chat"

Out of scope for a "remove RAUX" PR and the links themselves are not broken (they point at /guides/agent-ui, which exists), but if the goal is one canonical product name, a follow-up that lands alongside or before the planned stale-strings CI workflow would close this loop.

Strengths

  • Clean removal of the entire RAUX block — the OpenWebUI acknowledgment section, the broken link to aigdat/raux/blob/main/README.md, and the misleading "lighter alternative to RAUX" framing all go in one pass; grep -ri "raux\|open-webui\|openwebui" docs/ confirms zero residue.
  • Side-quest improvement that the PR description doesn't even mention: the architecture section's ASCII em-dash placeholders (--) are upgraded to real em-dashes (—), making the rendered Mintlify page typographically correct.
  • Adds an --- rule before the renamed Architecture section, which fixes the previous run-on between Installation and the standalone-app description on the rendered page.

Verdict

Approve with suggestions — Docs-only, accomplishes its stated goal, and the test plan checks all pass on the head. The casing nit is a one-line decision (Gaia Agent UI vs GAIA Agent UI) that's better resolved before the planned stale-strings CI workflow lands rather than after.

@itomek itomek added this pull request to the merge queue Apr 30, 2026
Merged via the queue into main with commit a3b1526 Apr 30, 2026
23 checks passed
@itomek itomek deleted the 929-remove-raux-references-docs branch April 30, 2026 20:09
@itomek itomek mentioned this pull request Apr 30, 2026
Closed
7 tasks
@itomek-amd itomek-amd mentioned this pull request May 4, 2026
Merged
10 tasks
theonlychant pushed a commit to theonlychant/gaia that referenced this pull request May 5, 2026
@itomek @theonlychant
docs(deployment): remove RAUX/Open-WebUI references from docs (amd#931)
4989eec 
## Summary

Removes all references to RAUX (the retired Open-WebUI fork) from the
documentation. RAUX is no longer part of GAIA; the current UI is the
Gaia Agent UI (`src/gaia/apps/webui/` + `src/gaia/ui/`).

## Why

`docs/deployment/ui.mdx` still contained a full "GAIA UI (RAUX)
Interface" section, including an acknowledgment block for the OpenWebUI
team and a link to the retired `aigdat/raux` repository. Three other doc
files used the bare "GAIA UI" label (which pointed contributors toward
the wrong product). These references misdirect external contributors and
are factually wrong.

Refs amd#929

## Changes

- `docs/deployment/ui.mdx` — removed the "GAIA UI (RAUX) Interface"
section entirely; renamed "GAIA Chat (Lightweight Desktop)" → "Gaia
Agent UI Architecture" and removed the "lighter alternative to RAUX"
framing; updated Developer Quick Start link text.
- `docs/guides/custom-agent.mdx` — "GAIA UI" → "Gaia Agent UI" (line
13).
- `docs/plans/axis-gaia-integration.md` — "GAIA UI" → "Gaia Agent UI"
(line 162).
- `docs/plans/desktop-installer.mdx` — "GAIA UI" → "Gaia Agent UI" (line
419).

**Must land before PR 3** (the stale-strings CI workflow), which
enforces the absence of these terms going forward.

## Test plan

- [ ] `grep -rn -i "raux\|open-webui\|openwebui" docs/` — zero hits
- [ ] `grep -rn "GAIA UI" docs/` (without "Agent") — zero hits
- [ ] All internal links in `docs/deployment/ui.mdx` resolve:
`/guides/agent-ui`, `/sdk/sdks/agent-ui`, `/spec/agent-ui-server`,
`/reference/troubleshooting#appimage-on-linux`

## Checklist

- [x] I have linked a GitHub issue above (`Refs amd#929`).
- [x] I have described **why** this change is being made, not just what
changed.
- [x] No code changes — docs only; lint and unit tests are not
applicable.
- [x] Documentation updated (this PR is the documentation update).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kovtcharov kovtcharov kovtcharov approved these changes
@kovtcharov-amd kovtcharov-amd Awaiting requested review from kovtcharov-amd kovtcharov-amd is a code owner

Assignees

@itomek itomek

Labels

documentation Documentation changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Streamline contributor onboarding: refresh templates, contributing guide, remove RAUX references, and prevent regression

2 participants

@itomek @kovtcharov