|
1 | 1 | Getting Started |
2 | 2 | =============== |
3 | 3 |
|
4 | | -Welcome to the FastForward DevTools getting started guide. This section provides an introduction to the ``fast-forward/dev-tools`` package, explaining its purpose and guiding you through the environment preparation. |
| 4 | +Welcome to the FastForward DevTools documentation. |
5 | 5 |
|
6 | | -What is FastForward DevTools? |
7 | | ------------------------------ |
| 6 | +FastForward DevTools is a modern orchestration toolkit for PHP projects, providing a unified interface for quality assurance and static analysis tools. With this toolkit, you can automate code style checks, refactoring, testing, and documentation generation across your PHP codebase. |
8 | 7 |
|
9 | | -Configuring tools like PHPUnit, Rector, PHP-CS-Fixer, EasyCodingStandard (ECS), and phpDocumentor in every new project leads to excessive boilerplate. FastForward DevTools eliminates this configuration fatigue by providing sensible defaults and a unified execution interface (``composer dev-tools``) out of the box. |
| 8 | +What does it do? |
| 9 | +---------------- |
10 | 10 |
|
11 | | -When you add this package as a development dependency, your project automatically inherits a unified command-line toolchain designed to ensure that all your projects adhere to the same rigorous standards without manual bootstrapping. |
| 11 | +By analyzing your PHP source code and configuration, FastForward DevTools automates the execution of QA tools, making it indispensable for teams seeking consistent, high-quality codebases. |
| 12 | + |
| 13 | +In addition to orchestrating standard tools, FastForward DevTools provides: |
| 14 | + |
| 15 | +- Unified command-line interface for all QA operations |
| 16 | +- Automatic configuration and sensible defaults |
| 17 | +- Support for custom project overrides |
| 18 | +- Seamless integration with Composer |
| 19 | + |
| 20 | +Inspired by best practices and modern PHP standards, FastForward DevTools helps you maintain, refactor, and document your projects efficiently. |
| 21 | + |
| 22 | +Where to start? |
| 23 | +--------------- |
| 24 | + |
| 25 | +We have divided the documentation into 4 main sections to help you navigate: |
| 26 | + |
| 27 | +1. :doc:`Getting Started <index>` (this guide) — concise tutorials to help you get started quickly. |
| 28 | +2. :doc:`Configuration <../configuration/index>` — in-depth guides on customizing and configuring the toolkit. |
| 29 | +3. :doc:`Running the Tools <../running/index>` — reference for all available commands and features. |
| 30 | +4. :doc:`Internals <../internals/index>` — for contributors and those interested in the internal architecture. |
| 31 | + |
| 32 | +.. hint:: |
| 33 | + |
| 34 | + The documentation pages you are currently reading are generated using FastForward DevTools and serve as a real-world example of its capabilities. |
12 | 35 |
|
13 | 36 | In this Section |
14 | 37 | --------------- |
|
0 commit comments