Skip to content

Commit bac2949

Browse files
[docs] Add mascot artwork to README and docs (#121) (#122)
* [docs] Add mascot artwork to README and docs (#121) * Update wiki submodule pointer for PR #122 * [docs] Refine mascot presentation (#121) * [docs] Update phpDocumentor template to v2 (#121) * [changelog] Record phpDocumentor template upgrade (#121) --------- Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 7446054 commit bac2949

8 files changed

Lines changed: 33 additions & 13 deletions

File tree

.github/wiki

Submodule wiki updated from 1dbc52c to cc53289

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1010
### Changed
1111

1212
- Document required GitHub Actions permissions for changelog release automation (#118)
13+
- Add the project mascot image to README and documentation (#121)
14+
- Upgrade the packaged phpDocumentor bootstrap template to v2.0.0 (#121)
1315

1416
## [1.12.0] - 2026-04-19
1517

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ across Fast Forward libraries.
1313
[![License](https://img.shields.io/github/license/php-fast-forward/dev-tools?color=64748B)](LICENSE)
1414
[![GitHub Sponsors](https://img.shields.io/github/sponsors/php-fast-forward?logo=githubsponsors&logoColor=white&color=EC4899)](https://github.com/sponsors/php-fast-forward)
1515

16+
<p align="center">
17+
<img src="docs/_static/mascot-banner.png" alt="Fast Forward DevTools mascot" width="840">
18+
</p>
19+
1620
## ✨ Features
1721

1822
- Aggregates refactoring, PHPDoc, code style, tests, and reporting under a

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
"ergebnis/composer-normalize": "^2.51",
4646
"ergebnis/rector-rules": "^1.18",
4747
"fakerphp/faker": "^1.24",
48-
"fast-forward/phpdoc-bootstrap-template": "^1.0",
48+
"fast-forward/phpdoc-bootstrap-template": "^2.0",
4949
"friendsofphp/php-cs-fixer": "^3.95",
5050
"icanhazstring/composer-unused": "^0.9.6",
5151
"jolicode/jolinotif": "^3.3",

docs/_static/mascot-banner.png

1.06 MB
Loading

docs/_static/mascot.png

1.45 MB
Loading

docs/index.rst

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
11
Documentation
22
=============
33

4-
FastForward DevTools is infrastructure for Fast Forward libraries. It ships
5-
shared defaults, registers Composer commands, generates documentation, and
6-
synchronizes automation plus packaged agent skills into consumer repositories.
4+
.. container:: row align-items-center gy-4 my-4
75

8-
If you are new to the package, start with :doc:`getting-started/index` and
9-
:doc:`usage/index`. If you maintain Fast Forward libraries, continue with
10-
:doc:`advanced/index`, :doc:`api/index`, and :doc:`internals/index` to
11-
understand how the Composer plugin, PHPUnit extension, and reusable workflows
12-
fit together.
6+
.. container:: col-lg-7
7+
8+
FastForward DevTools is the shared infrastructure layer for Fast Forward
9+
libraries. It keeps Composer commands, documentation generation,
10+
reporting, workflow automation, and packaged agent skills moving in the
11+
same direction.
12+
13+
If you are new to the package, start with
14+
:doc:`getting-started/index` and :doc:`usage/index` for installation, the
15+
first successful run, and the core command flow.
16+
17+
If you maintain Fast Forward libraries, continue with
18+
:doc:`advanced/index`, :doc:`api/index`, and :doc:`internals/index` to
19+
understand how the Composer plugin, PHPUnit extension, and reusable
20+
workflows fit together.
21+
22+
.. container:: col-lg-5 text-center
23+
24+
.. image:: _static/mascot.png
25+
:alt: Fast Forward DevTools mascot
26+
:class: img-fluid w-100 rounded-4 shadow-sm border border-light-subtle bg-body-tertiary p-2
1327

1428
.. toctree::
15-
:maxdepth: 2
29+
:maxdepth: 1
1630
:caption: Contents
1731

1832
getting-started/index

resources/phpdocumentor.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<source dsn="{{ workingDirectory }}">
3636
<path>{{ guidePath }}</path>
3737
</source>
38-
<output>guide</output>
38+
<output>.</output>
3939
</guide>
4040
</version>
41-
</phpdocumentor>
41+
</phpdocumentor>

0 commit comments

Comments
 (0)