|
| 1 | +--- |
| 2 | +title: Documentation |
| 3 | +linkTitle: Docs |
| 4 | +weight: 10 |
| 5 | +description: Piglet Run documentation - AI coding sandbox with PostgreSQL, JuiceFS, VS Code, and more. |
| 6 | +icon: fa-solid fa-book |
| 7 | +--- |
| 8 | + |
| 9 | +Welcome to **Piglet Run** documentation! |
| 10 | + |
| 11 | +Piglet Run is a lightweight runtime environment from Pigsty, designed as a cloud coding sandbox for AI Web Coding. It integrates PostgreSQL database, JuiceFS distributed storage, VS Code, JupyterLab, and more into a unified environment. |
| 12 | + |
| 13 | +## Documentation Structure |
| 14 | + |
| 15 | +Our documentation follows the **Diataxis** framework, organized into four categories: |
| 16 | + |
| 17 | +| Category | Purpose | Example | |
| 18 | +|----------|---------|---------| |
| 19 | +| [**Concept**](/docs/concept/) | Understand the principles | What is Piglet Run? How does snapshot work? | |
| 20 | +| [**Tutorial**](/docs/tutorial/) | Learn step by step | Install Piglet Run, Create your first project | |
| 21 | +| [**Task**](/docs/task/) | Get specific things done | Backup database, Deploy application | |
| 22 | +| [**Reference**](/docs/reference/) | Look up detailed info | Configuration options, CLI commands | |
| 23 | + |
| 24 | +## Quick Links |
| 25 | + |
| 26 | +- **New to Piglet Run?** Start with the [Installation Tutorial](/docs/tutorial/install/) |
| 27 | +- **Want to understand the concepts?** Read [What is Piglet Run?](/docs/concept/overview/) |
| 28 | +- **Looking for how-to guides?** Check the [Task](/docs/task/) section |
| 29 | +- **Need detailed reference?** See the [Reference](/docs/reference/) section |
| 30 | + |
| 31 | +## Core Features |
| 32 | + |
| 33 | +| Feature | Description | |
| 34 | +|---------|-------------| |
| 35 | +| 🤖 AI Coding | Pre-installed Claude Code, VS Code, Jupyter, Python/Go/Node.js | |
| 36 | +| 🐘 Data Powerhouse | PostgreSQL 18 + 400+ extensions | |
| 37 | +| 💾 Shared Storage | JuiceFS stores workspace in database | |
| 38 | +| ⏱️ Time Machine | Database PITR + filesystem snapshots | |
| 39 | +| 🔀 Instant Clone | Copy-on-Write database forking | |
| 40 | +| 🌐 One-Click Deploy | Built-in Nginx with auto SSL | |
| 41 | +| 📊 Full Observability | VictoriaMetrics + Grafana | |
0 commit comments