Vibex documentation

This repository contains the Mintlify documentation site for Vibex.

The site is organized into three locales:

• Simplified Chinese at the root path (/)
• Traditional Chinese under /zh-TW/
• English under /en/

Each locale has a User guide, a Developer guide, and a Changelog. Product behavior is documented from the current Vibex desktop, mobile, Remote v2, and Relay implementations. Pages use concise workflows, structured evidence, and redacted diagnostics without embedding workspace data.

Local preview

Vibex docs use the Mintlify CLI. Node.js 22 is the supported runtime for the current CLI installation.

mint dev

Open http://localhost:3000 after the preview starts.

Validate the configuration and links with:

mint validate
mint broken-links
mint a11y

The navigation and site settings live in docs.json. Pages are MDX files with YAML frontmatter.

Changelog

The Changelog tab mirrors the release notes kept in the Vibex repository (docs/operations/release-notes-*.md). Every release has one page per locale under changelog/, zh-TW/changelog/, and en/changelog/.

To add a release:

1. Add the release note body to each locale's page, with the section headings the note already uses (## Highlights / ## 亮点 and so on).
2. Register the page in that locale's Changelog tab in docs.json.
3. Add the release to changelog/index.mdx, zh-TW/changelog/index.mdx, and en/changelog/index.mdx.

Do not wrap the body in Mintlify's <Update> component: on these pages it renders as a two-column card whose body is clipped, so the release note renders as plain page content.

Traditional Chinese pages are converted from Simplified Chinese, then adjusted for Taiwan terminology such as 工作區, 供應商設定, 桌面端, and 行動端.