|
| 1 | +.. toctree:: |
| 2 | + :hidden: |
| 3 | + :titlesonly: |
| 4 | + |
| 5 | + getting-started/index |
| 6 | + configuration/index |
| 7 | + running/index |
| 8 | + internals/index |
| 9 | + |
| 10 | +FastForward DevTools Guide |
| 11 | +========================= |
| 12 | + |
| 13 | +Welcome to the documentation for FastForward DevTools. |
| 14 | + |
| 15 | +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. |
| 16 | + |
| 17 | +This documentation is organized into the following sections: |
| 18 | + |
| 19 | +- **Getting Started** — Quick tutorials to get you up and running in minutes. See :doc:`getting-started/index`. |
| 20 | +- **Configuration** — Learn how to customize and override default behaviors. See :doc:`configuration/index`. |
| 21 | +- **Running the Tools** — Discover how to run the unified and specialized commands. See :doc:`running/index`. |
| 22 | +- **Internals** — Dive into the architecture and design of the toolkit. See :doc:`internals/index`. |
| 23 | + |
| 24 | +What does it do? |
| 25 | +---------------- |
| 26 | + |
| 27 | +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. |
| 28 | + |
| 29 | +In addition to orchestrating standard tools, FastForward DevTools provides: |
| 30 | + |
| 31 | +- Unified command-line interface for all QA operations |
| 32 | +- Automatic configuration and sensible defaults |
| 33 | +- Support for custom project overrides |
| 34 | +- Seamless integration with Composer |
| 35 | + |
| 36 | +Inspired by best practices and modern PHP standards, FastForward DevTools helps you maintain, refactor, and document your projects efficiently. |
| 37 | + |
| 38 | +Where to start? |
| 39 | +--------------- |
| 40 | + |
| 41 | +We have divided the documentation into 4 sections: |
| 42 | + |
| 43 | +1. :doc:`getting-started/index` — concise tutorials to help you get started quickly. |
| 44 | +2. :doc:`configuration/index` — in-depth guides on customizing and configuring the toolkit. |
| 45 | +3. :doc:`running/index` — reference for all available commands and features. |
| 46 | +4. :doc:`internals/index` — for contributors and those interested in the internal architecture. |
| 47 | + |
| 48 | +.. hint:: |
| 49 | + |
| 50 | + The documentation pages you are currently reading are generated using FastForward DevTools and serve as a real-world example of its capabilities. |
0 commit comments