Skip to content

CLAUDE.md

Latest commit

 

History

History
58 lines (38 loc) · 2.31 KB

CLAUDE.md

File metadata and controls

58 lines (38 loc) · 2.31 KB

CLAUDE.md

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

Project Overview

VeeCode Platform documentation site built with Docusaurus 3. Contains docs for four products: DevPortal, Admin-UI, Platform, and VKDR-CLI.

Branching and Deployment

  • develop (default branch) — force-pushed to docs-next repo → deploys to staging (https://docs-next.platform.vee.codes/)
  • main — deploys to production (https://docs.platform.vee.codes/)

Feature branches should be created off develop. PRs target develop. Merge develop → main for production releases.

Commands

yarn start      # Local dev server with hot reload
yarn build      # Production build to ./build
yarn serve      # Serve the production build locally
yarn clear      # Clear Docusaurus cache (useful when builds behave unexpectedly)

Requires Node.js >= 20. Uses Yarn 4 via Corepack (corepack enable to activate).

Architecture

Multi-instance docs

The site uses Docusaurus multi-instance docs (not a single docs/ folder). Each product has its own content directory at the repo root, configured as a separate plugin-content-docs instance in docusaurus.config.js:

Directory Route base Plugin ID
devportal/ /devportal default
platform/ /platform platform
admin-ui/ /admin-ui admin-ui
vkdr/ /vkdr vkdr

All four instances share a single sidebars.js (autogenerated from directory structure).

Custom pages and components

  • src/pages/ — Custom landing page (index.js)
  • src/components/ — Shared React components (header, footer, button)
  • src/css/custom.css — Global theme overrides

Notable plugins/features

  • Mermaid diagrams enabled via @docusaurus/theme-mermaid
  • Image zoom via docusaurus-plugin-image-zoom (add class zoomable to images)
  • Client redirects configured in docusaurus.config.js for legacy URL compatibility

Content Conventions

  • Each doc section has an intro.md as its landing page
  • Sidebar ordering is autogenerated from filesystem structure (use numeric prefixes or _category_.json files to control order)
  • Documentation is English-only (i18n configured for en)