Skip to content

docs: route Open WebUI into integrations - #83

Open
acedatacloud-dev wants to merge 1 commit into
mainfrom
docs/publish-open-webui-guide
Open

docs: route Open WebUI into integrations#83
acedatacloud-dev wants to merge 1 commit into
mainfrom
docs/publish-open-webui-guide

Conversation

@acedatacloud-dev

Copy link
Copy Markdown
Member

Why

AceDataCloud already has a detailed Open WebUI integration guide in the PlatformBackend source: token setup, correct OpenAI-compatible base URLs, model verification, a real curl check, and troubleshooting. The Docs sync silently skips it because platform-level client integrations do not match an API/service alias and the exact-map allowlist only recognizes the coding document-only namespace.

The content exists, but it cannot become a stable guides/integrations/... page. Adding another article would duplicate work; routing the authoritative source into Docs is the higher-leverage fix.

What changed

  • add integrations as an allowed document-only guide namespace;
  • add an exact mapping:
    • source: development_open_webui.md
    • canonical platform alias: development_open_webui
    • output: guides/integrations/open-webui.mdx
  • add a focused sync test that creates a platform-level integration source, loads the exact map, and proves the MDX lands at the discoverable integration path.

This reuses the existing exact-map safety checks: known namespace, existing source, required .mdx suffix, no traversal, unique source, and unique output.

Validation

  • tests/test_sync_from_platformbackend.py — 31/31 passed
  • new integration exact-path test generates zh-Hans/guides/integrations/open-webui.mdx
  • Python compile check — passed
  • exact-map JSON parse — passed
  • existing Docs navigation validation — passed
  • git diff --check — clean

Generation / rollout

This PR changes the generation authority, not a generated MDX file. The standard Docs sync requires PUBLIC_EXAMPLE_DENYLIST and the production translation/data credentials; local full generation correctly failed closed when that secret was unavailable. After merge, the normal protected sync produces localized pages from PlatformBackend and the Translation API. A separate focused navigation PR should be opened only after generated files exist, avoiding a broken nav entry in this PR.

Scope boundaries

This PR publishes only the Open WebUI source mapping. It does not hand-edit generated MDX, duplicate the guide, change the guide content, or add Cherry Studio/LobeChat; those can use the same namespace in separate PRs.

Rollback

Revert the exact record and namespace addition. The PlatformBackend source document remains unchanged.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant