CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

This is a VitePress documentation site for Pratham ResPOS — a Point of Sale system for restaurant operations (Windows desktop, Android, iOS). The site is built with VitePress and managed with Bun.

Commands

bun run dev          # Start local dev server
bun run build        # Build for production (outputs to .vitepress/dist)
bun run preview      # Preview the production build
bun run fmt          # Format code with oxfmt
bun run fmt:check    # Check formatting without writing

Linting is via oxlint — configured in .oxlintrc.json. Formatting is via oxfmt — configured in .oxfmtrc.json (single quotes, no semi, print width 120, trailing comma none).

Architecture

The site has two top-level documentation sections, each with its own sidebar in .vitepress/config.ts:

Path	Purpose	Audience
/pos/	POS Guide — operator guide + setup & configuration	Cashiers, waitstaff, managers, admins, IT
/admin/	Admin Guide — browser-based admin portal	Managers, support staff

POS section structure

The /pos/ section has a single sidebar with two groups:

• Operator Guide — top-level operator topics (pos/*.md) covering daily usage
• Setup & Configuration (collapsed) — lives under pos/setup/ as a sub-folder

Sub-folders:

• pos/products/ — menu sub-section (deals, half-n-half, custom items)
• pos/setup/ — first-time setup, POS settings, hardware, displays, payment gateways, receipt customisation

Admin section structure

The /admin/ section uses a two-tier pattern:

• admin/modules/ — short overview pages, one per feature area (reports, inventory, master-data, etc.)
• admin/reference/ — detailed per-screen pages covering all fields, CRUD operations, and workflows
• admin/using-the-admin/ — navigation, dashboard, access concepts
• admin/your-account/ — sign-in, password reset
• admin/getting-started/ — initial access

Guide section structure

• guide/*.md — top-level operator topics (orders, payments, tables, customers, cash-up, etc.)
• guide/products/ — menu sub-section (deals, half-n-half, custom items)

Config

All sidebar navigation is defined in .vitepress/config.ts — this is the single source of truth for what pages appear in the nav and sidebars. When adding new pages, register them here.

The only TypeScript file in the project is .vitepress/config.ts. All content files are Markdown (.md).