Skip to content

CLAUDE.md

Latest commit

 

History

History
63 lines (50 loc) · 2.36 KB

CLAUDE.md

File metadata and controls

63 lines (50 loc) · 2.36 KB

CLAUDE.md

Project Overview

Tailor Platform documentation site built with VitePress 1.6.4. Contains technical docs, SDK guides, and ERP app building guides.

Quick Commands

  • pnpm dev — Start dev server (http://localhost:5173)
  • pnpm build — Production build
  • pnpm preview — Preview production build
  • pnpm lint — Lint with oxlint
  • pnpm fmt — Format with oxfmt

Project Structure

docs/
├── .vitepress/
│   ├── config.mts          # Main VitePress config
│   ├── config/             # Config modules (nav, sidebar, markdown, utils, constants)
│   └── theme/              # Custom theme (components, styles)
├── docs/                   # All documentation content (srcDir)
│   ├── index.md
│   ├── getting-started/
│   ├── sdk/
│   ├── guides/
│   ├── tutorials/
│   ├── reference/
│   └── administration/
├── scripts/                # Utility scripts (mdx-to-md, sdk-sync, validate-schema, etc.)
├── schema.yml              # Schema validation config for docs
├── _typos.toml             # Typo checker config
└── .mdschema.yml           # Markdown schema config

Key Conventions

  • Package manager: pnpm (v10.28.0)
  • Docs source dir: docs/ (configured as srcDir in VitePress)
  • Section overviews: Use overview.md — these are automatically ranked first in navigation
  • Navigation & sidebars: Auto-generated from filesystem in .vitepress/config/nav.ts and sidebar.ts
  • Custom components: <Card>, <GitHubIcon>, grid classes (.cards, .cards-2, .cards-3)
  • Mermaid diagrams: Supported via vitepress-plugin-mermaid
  • Custom containers: Supported via markdown-it-container

Writing Docs

  • Place markdown files in the appropriate folder under docs/
  • Use frontmatter for metadata
  • Internal links should be extensionless (resolved at build time)
  • External links are restricted to: github.com, tailor.tech, localhost, 127.0.0.1
  • Headings must not skip levels (e.g., h1 -> h3 is invalid), max depth is h4
  • Custom words in _typos.toml won't be flagged by the typo checker

CI Checks

GitHub Actions workflows run on PRs:

  • schema-check — Validates doc structure
  • link-check — Validates links
  • typo_check — Catches typos
  • sdk-docs-sync — Syncs SDK documentation