zorio-docs

Mã nguồn portal tài liệu chính thức cho hệ thống Zorio Contact Center — phát hành tại https://docs.zorio.vn.

Stack

• VitePress 1.6 (Vue 3 + Vite) — SSG markdown-driven, multi-level sidebar, full-text search built-in.
• i18n vi/en song song (chuẩn locale của VitePress).
• AI-agent friendly: tự động sinh /llms.txt + /llms-full.txt + raw markdown .md mirror + sitemap.xml.

Yêu cầu

• Node.js ≥ 18 (test ở Node 20).
• npm ≥ 10.

Phát triển cục bộ

npm install
npm run dev          # vitepress dev server tại http://localhost:5173

Build production

npm run build:all    # vitepress build + sinh llms.txt + raw .md mirror

Output ở .vitepress/dist/. Deploy lên web server (nginx static) — xem mục Deploy.

Cấu trúc folder

zorio-docs/
├── .vitepress/
│   ├── config.ts             # Cấu hình portal: title, i18n, sidebar, head meta
│   └── dist/                 # Output build (gitignored)
├── scripts/
│   └── build-llms-txt.mjs    # Generate /llms.txt + /llms-full.txt + raw .md mirror
├── public/                   # Static assets — copy nguyên vào dist (favicon, og-image, ...)
├── index.md                  # Trang chủ (default locale = tiếng Việt)
├── bat-dau/                  # Bắt đầu
├── auth/                     # Xác thực & Bảo mật
├── api/
│   ├── pbx/                  # PBX API (DELI-34)
│   ├── telesales/            # Telesales API (DELI-7)
│   └── autocall/             # AutoCall TTS API (DELI-27)
├── sdk/
│   └── webphone/             # Webphone SDK (DELI-8)
├── webhooks/                 # Webhooks chung
├── tham-chieu/               # Tham chiếu (hangup codes, HTTP codes, glossary, FAQ)
└── en/                       # English mirror
    ├── index.md
    ├── getting-started/
    ├── auth/
    ├── api/...
    └── ...

Thêm trang mới

1. Tạo file .md ở folder phù hợp (vd api/cskh/khach-hang.md).
2. Mở .vitepress/config.ts → thêm entry vào sidebarVi (và sidebarEn nếu có bản EN).
3. Run npm run dev để preview cục bộ.
4. Run npm run build:all để sinh production assets.

Module mới (vd CSKH 360, Omnichannel, Pool Softswitch)

1. Tạo folder api/<module-slug>/ chứa index.md + sub-pages.
2. Thêm group trong sidebarVi ở .vitepress/config.ts.
3. Thêm entry vào themeConfig.nav (top navigation) nếu muốn highlight.

AI agent friendly

Mọi page tự động được phát hành thêm các kênh dành cho LLM crawler:

Kênh	Mục đích	URL
/llms.txt	Sitemap dạng markdown 1 dòng/page	https://docs.zorio.vn/llms.txt
/llms-full.txt	Toàn bộ docs gộp thành 1 file markdown duy nhất	https://docs.zorio.vn/llms-full.txt
Raw .md	Thêm .md vào URL bất kỳ	https://docs.zorio.vn/api/pbx/extensions.md
OpenAPI YAML	(Phase 2) Auto-discover endpoint cho client gen	https://docs.zorio.vn/openapi/...
Sitemap XML	Chuẩn SEO/crawler	https://docs.zorio.vn/sitemap.xml

Generator script: scripts/build-llms-txt.mjs. Tham chiếu chuẩn de-facto llmstxt.org.

Deploy

Sample nginx config có sẵn ở deploy/nginx.docs.zorio.vn.conf (đang chuẩn bị).

Quy trình:

npm ci
npm run build:all
rsync -a --delete .vitepress/dist/ user@host:/var/www/docs.zorio.vn/
sudo nginx -t && sudo systemctl reload nginx

License

Copyright © 2026 Zorio. All rights reserved.