Central docs repo covering technical docs and ERP app building guides.
This repository contains the documentation for Tailor Platform, built with VitePress. It includes comprehensive guides for SDK, services, integrations, and platform features.
The documentation is organized into several main sections:
- Getting Started - Introduction to Tailor Platform and core concepts
- SDK - Platform SDK documentation and CLI reference
- Guides - In-depth guides for TailorDB, Auth, Pipeline, Functions, and more
- References - API references and legacy tool documentation
Clone the repository and install dependencies:
git clone http://github.com/tailor-platform/docs.git
cd docs
pnpm installStart the development server with hot reload:
pnpm devThe documentation will be available at http://localhost:5173
Build the documentation for production:
pnpm buildPreview the production build locally:
pnpm previewdocs/
├── .vitepress/ # VitePress configuration and theme
│ ├── config.mts # Site configuration
│ └── theme/ # Custom theme components
│ ├── components/ # Reusable Vue components (Card, Tabs, etc.)
│ └── styles/ # Custom styles
├── docs/ # Documentation content
│ ├── getting-started/ # Getting started guides
│ ├── sdk/ # SDK documentation
│ ├── guides/ # Feature guides
│ └── references/ # API references
└── scripts/ # Utility scripts
When adding new documentation:
- Place markdown files in the appropriate folder under
docs/ - Use
overview.mdfor section overviews (automatically ranked first in navigation) - Follow the existing structure and conventions
- Use the custom components (Card, CardGrid) for enhanced layouts
The documentation includes several custom Vue components:
<Card>- Display clickable cards with icons and descriptions<GitHubIcon>- GitHub icon component- Grid classes -
.cards,.cards-2,.cards-3for responsive card layouts