Skip to content

Commit 78098ef

Browse files
committed
Update docs
1 parent 76761b9 commit 78098ef

2 files changed

Lines changed: 17 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,12 @@ composer dev-tools refactor
4343
# Check and fix PHPDoc comments
4444
composer dev-tools phpdoc
4545

46-
# Generate API documentation using phpDocumentor
46+
# Generate HTML API documentation using phpDocumentor
4747
composer dev-tools docs
4848

49+
# Generate Markdown documentation for the wiki
50+
composer dev-tools wiki
51+
4952
# Generate documentation frontpage and related reports
5053
composer dev-tools reports
5154
```

docs/running/specialized-commands.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,25 @@ Intelligently audits your project methods to identify lacking definitions, execu
4545
4646
composer dev-tools phpdoc
4747
48-
5. API Documentation (``docs``)
49-
-------------------------------
48+
5. HTML Documentation (``docs``)
49+
--------------------------------
5050

51-
Reads defined PSR-4 paths logically extracting explicit structures accurately. It deploys Markdown documentation describing your internal structural hierarchy inside ``docs/wiki``.
51+
Reads defined PSR-4 paths logically extracting explicit structures accurately. It deploys HTML documentation describing your internal structural hierarchy using phpDocumentor.
5252

5353
.. code-block:: bash
5454
5555
composer dev-tools docs
5656
57-
6. Reports Output (``reports``)
57+
6. Wiki Markdown Documentation (``wiki``)
58+
-----------------------------------------
59+
60+
Extracts explicit API structures and deploys Markdown documentation representing your architectural hierarchy directly into the ``.github/wiki`` repository.
61+
62+
.. code-block:: bash
63+
64+
composer dev-tools wiki
65+
66+
7. Reports Output (``reports``)
5867
-------------------------------
5968

6069
Structurally consolidates distinct reporting commands, accurately aggregating testing coverage and docs into clean visual output components.

0 commit comments

Comments
 (0)