https://github.com/tailor-platform/docs
Tailor Platform documentation
https://github.com/tailor-platform/docs
Last synced: 2 months ago
JSON representation
Tailor Platform documentation
- Host: GitHub
- URL: https://github.com/tailor-platform/docs
- Owner: tailor-platform
- Created: 2026-02-26T06:16:11.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-04T00:38:15.000Z (2 months ago)
- Last Synced: 2026-04-04T00:53:14.692Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 7.83 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Tailor Platform Documentation
Central docs repo covering technical docs and ERP app building guides.
## Overview
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
## Installation
Clone the repository and install dependencies:
```bash
git clone https://github.com/tailor-platform/docs.git
cd docs
pnpm install
```
## Usage
### Development
Start the development server with hot reload:
```bash
pnpm dev
```
The documentation will be available at `http://localhost:5173`
### Build
Build the documentation for production:
```bash
pnpm build
```
### Preview
Preview the production build locally:
```bash
pnpm preview
```
## Project Structure
```
docs/
├── .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
```
## Contributing
When adding new documentation:
1. Place markdown files in the appropriate folder under `docs/`
2. Use `overview.md` for section overviews (automatically ranked first in navigation)
3. Follow the existing structure and conventions
4. Use the custom components (Card, CardGrid) for enhanced layouts
## Custom Components
The documentation includes several custom Vue components:
- **``** - Display clickable cards with icons and descriptions
- **``** - GitHub icon component
- **Grid classes** - `.cards`, `.cards-2`, `.cards-3` for responsive card layouts