Skip to content

Commit 2341f38

Browse files
committed
Update docs
1 parent 94f6bcf commit 2341f38

3 files changed

Lines changed: 33 additions & 50 deletions

File tree

docs/getting-started/index.rst

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,37 @@
11
Getting Started
22
===============
33

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.
55

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.
87

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+
----------------
1010

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.
1235

1336
In this Section
1437
---------------

docs/index.rst

Lines changed: 4 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,10 @@
1+
Documentation
2+
=============
3+
14
.. toctree::
2-
:hidden:
35
:titlesonly:
46

57
getting-started/index
68
configuration/index
79
running/index
8-
internals/index
9-
10-
Documentation
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.
10+
internals/index

src/Command/DocsCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ protected function configure(): void
5454
shortcut: 't',
5555
mode: InputOption::VALUE_OPTIONAL,
5656
description: 'Path to the output directory for the generated HTML documentation.',
57-
default: 'public/docs',
57+
default: 'public',
5858
)
5959
->addOption(
6060
name: 'source',

0 commit comments

Comments
 (0)