CLAUDE.md

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

Project Overview

This is the ACEware Help Center documentation website, built with VitePress. It provides comprehensive help documentation for ACEware products including:

• Student Manager: Course management, registrations, payments, names, reporting, ACEweb, and various modules
• Report Wizard: Report creation, editing, scheduling, and advanced design tools

The site is deployed at https://help.aceware.com and uses Algolia for search functionality with AI-powered assistance.

Development Commands

Local Development

npm run docs:dev

Starts the Vite development server on http://localhost:3001 with hot reload

Build for Production

npm run docs:build

Builds the static site to .vitepress/dist directory

Preview Production Build

npm run docs:preview

Preview the production build locally

Architecture

Configuration Structure

The .vitepress/config.mts file (1602 lines) is the central configuration hub containing:

• Navigation structure: Multi-level dropdown menus organized by product
• Sidebar configuration: Extensive nested sidebar items for each product area
• Search integration: Algolia DocSearch with AI assistant enabled
• Theme customization: Logo variants (light/dark mode), footer, and metadata
• Site settings: Language, title, description, sitemap configuration

Content Organization

Documentation is organized by product in top-level directories:

• student-manager/: Largest section with 30+ subdirectories covering all modules (courses, names, registrations, payments, reporting, aceweb, faculty, workshops, etc.)
• report-wizard/: Report creation guides, advanced designer documentation, FAQs

Each product area contains:

• links.md files: Act as landing pages for major sections
• Nested subdirectories: Organize related documentation by feature/module
• Screen layout docs: Detailed field-level documentation

Theme Customization

Located in .vitepress/theme/:

• Layout.vue: Custom layout extending VitePress default theme with smooth dark mode transitions using the View Transitions API
• index.ts: Theme entry point that registers the custom layout
• custom.css: Additional styling overrides

Deployment

AWS CodeBuild is configured via buildspec.yml:

• Uses Node.js 18
• Runs npm install and npm run docs:build
• Outputs artifacts from .vitepress/dist

Working with Navigation and Sidebar

When adding or modifying documentation:

1. Add the markdown file in the appropriate product directory
2. Update the sidebar configuration in .vitepress/config.mts for the relevant section
3. Navigation menu items in the nav array link to major landing pages
4. Sidebar items support nested collapsible sections with collapsed: true

Development Environment

• Node.js Version: 18.18.0 LTS (managed via nvm)
• Framework: VitePress 2.0.0-alpha.12
• Build Tool: Vite (bundled with VitePress)
• Analytics: Google Analytics (G-06RHMKPZMR)

Special Features

• Lazy image loading: Enabled in markdown configuration
• Last updated timestamps: Enabled via lastUpdated: true
• README exclusion: README.md files are excluded from site build via srcExclude
• Dark mode: Custom smooth transition animation using View Transitions API
• Search: Algolia DocSearch with AI assistant (assistantId: kLAcK0fkyxAt)