Skip to content

Docs (apps/docs)

Documentation site built with VitePress, covering user guides, API reference, and developer resources.

Overview

The docs workspace hosts the comprehensive documentation for the entire Booking Platform monorepo. It includes user-facing guides, API references, product information, and development resources.

Tech Stack

LayerTechnologyVersion
DocumentationVitePress^1.6.4
UI FrameworkVue 3^3.5.39
StylingUnoCSS^66.7.5
Twoslash@shikijs/vitepress-twoslash^4.3.1
Group Iconsvitepress-plugin-group-icons^1.7.5
RuntimeBun>= 1.3.0
LintingBiome^2.5.4

Structure

apps/docs/
├── .vitepress/
│   ├── config.mts           # VitePress configuration
│   ├── theme/
│   │   ├── index.ts          # Theme entry with Vue components
│   │   ├── theme.css         # CSS variables for theme colors
│   │   ├── styles.css        # Custom VitePress brand styles
│   │   └── components/       # Vue components for dynamic data
│   ├── scripts/             # Data generation scripts
│   │   ├── generate-data.ts  # Main data generation entry
│   │   └── collectors/       # Data collectors for project info
│   └── data/                # Generated JSON data for Vue components
├── uno.config.ts             # UnoCSS config (workspace root)
├── index.md                  # Home page (VitePress layout: home)
├── project/                  # Project overview, features, workspaces
├── features/                 # Dynamic features table
├── getting-started/          # Getting started guides (5 pages)
├── guides/                   # User guides (12 pages)
├── product/                  # Product documentation (7 pages)
├── workspaces/               # Workspace documentation (10 pages)
├── api/                      # API reference (19 pages)
├── resources/                # FAQ, troubleshooting, best practices (5 pages)
├── review/                   # Code review and test results
├── release/                  # Changelog and commits
├── development/              # Contributing, testing, workflows (5 pages)
├── security/                 # Security documentation
├── examples/                 # Code examples
├── package.json
├── tsconfig.json
└── README.md

Key Scripts

bash
# Development
moon run apps-docs:dev       # Start dev server (port 5173)

# Build
moon run apps-docs:build

# Preview
moon run apps-docs:preview

# Quality
moon run apps-docs:lint
moon run apps-docs:verify

Released under the MIT License.