> For the complete documentation index, see [llms.txt](https://pedal.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pedal.gitbook.io/docs/introduction.md).

# Introduction

Welcome to PEDAL: the next-generation platform for declarative, type-safe, and extensible API and data pipeline development.

***

## Why PEDAL?

PEDAL is engineered for ambitious teams and 10x engineers who demand:

* **Type Safety at Scale**: End-to-end type guarantees, from product requirements to runtime validation, powered by Zod and TypeScript.
* **Declarative Workflows**: Define your entire API, data models, and validation logic in a single source of truth—no more drift between docs, code, and tests.
* **Automated Code Generation**: Instantly generate OpenAPI, Zod schemas, TypeScript types, and more from high-level specifications.
* **Extensibility**: Plugin-friendly architecture lets you customize, extend, and automate every stage of your pipeline.
* **Production-Grade Quality**: Comprehensive test coverage, robust validation, and performance benchmarks ensure reliability at scale.

***

## What You'll Find Here

* **Quick Start**: Get up and running in minutes with real-world examples.
* **Core Concepts**: Deep dive into PEDAL's architecture, workflow syntax, and design philosophy.
* **Tutorials**: Step-by-step guides for advanced usage, integration, and customization.
* **Reference**: Detailed API docs, configuration options, and error codes.
* **Troubleshooting**: Proven strategies for debugging, performance tuning, and diagnostics.
* **Contributing**: Guidelines for extending PEDAL and submitting high-impact PRs.

***

## Built for Builders

PEDAL is trusted by top engineering teams to:

* Eliminate boilerplate and manual schema drift
* Accelerate delivery of robust, well-documented APIs
* Empower teams to focus on business logic, not plumbing
* Scale confidently with type safety, validation, and automation

***

Ready to build the future of APIs and data pipelines? Dive in, explore, and join the PEDAL community of world-class engineers.

## What is PEDAL?

PEDAL is designed to streamline and automate workflows for developers, DevOps, and product teams. It offers a CLI, API, and web interface, integrates with GitHub and CI/CD tools, and is extensible via scripts and webhooks.

* **Vision:** Automate the product engineering lifecycle for efficiency, scalability, and integration.
* **Audience:** Developers, DevOps, project managers, admins, and contributors.

## Quick Links

* [Quick Start Guide](/docs/quick-start.md)
* [Installation & Setup](https://github.com/ForestMars/PEDAL/blob/main/docs/installation/index.md)
* [Core Features](/docs/index-1.md)
* [Using PEDAL](/docs/api/cli.md)
* [Integrations](https://github.com/ForestMars/PEDAL/blob/main/docs/integrations/index.md)
* [Extending PEDAL](https://github.com/ForestMars/PEDAL/blob/main/docs/extending/scripts.md)
* [Administration](https://github.com/ForestMars/PEDAL/blob/main/docs/administration/user-management.md)
* [Troubleshooting](/docs/common-issues.md)
* [Reference](/docs/cli.md)
* [Tutorials](/docs/getting-started.md)
* [Getting Help](/docs/common-issues/getting-help.md)

***

> **Tip:** Use the sidebar or search to navigate. This documentation is organized for all user personas, from new users to advanced contributors.