BAAS Docs
User Guide

Web Wiki

The in-app Docs page loads the web documentation site by default and can detach into a separate Tauri window.

BAAS Tauri no longer uses the old local Wiki article list as the main documentation entry. The Docs page loads the web documentation site generated from baas-tauri/docs with Fumadocs.

Embedded Mode

Open Docs from the sidebar to display the web documentation inside the main window. This is useful when you want to read while configuring tasks.

The page shows:

  • Wiki title.
  • Current loading state.
  • Detach button.
  • Failure message and Wiki URL if loading fails.

Detached Window

Click Detach to create a normal system window for the same documentation site. The main window then shows that the docs are open separately and offers actions to focus the detached window or return the docs to the main window.

Window titles follow language:

  • Chinese: 百科文档
  • English: Wiki Docs

The detached window is a normal system window and no longer uses the old traffic-light visual decoration.

Languages and Fallback

The documentation site maintains only Chinese and English. Japanese, Korean, French, German, and Russian UI languages fall back to English documentation. Use the language menu in the documentation top bar to switch between Chinese and English.

Local Development URL

Local development usually runs at:

http://localhost:3000/docs/zh/
http://localhost:3000/docs/en/

After GitHub Pages deployment, the in-app Wiki URL can be changed to the deployed URL.

Loading Failures

If the Docs page keeps failing:

  • Open the same Wiki URL in a browser to confirm network or local dev server availability.
  • For GitHub Pages, confirm Pages is enabled and NEXT_PUBLIC_BASE_PATH matches the repository Pages path.
  • For local development, confirm the Next dev server is running under docs.
  • If detached mode works but embedded mode fails, check WebView2, proxy settings, and iframe sandbox constraints.

On this page