Added docs generator.

drevops · Nov 6, 2024 · d26b845 · d26b845
1 parent ebeb70b
commit d26b845
Show file tree

Hide file tree

Showing 15 changed files with 1,484 additions and 210 deletions.
diff --git a/.ahoy.yml b/.ahoy.yml
@@ -125,6 +125,14 @@ commands:
       && ahoy cli "cd /app/build && ./vendor/bin/rector --clear-cache" \
       && ahoy cli "cd /app/build && ./vendor/bin/phpcbf"
 
+  lint-docs:
+    usage: Lint docs.
+    cmd: ahoy cli "php docs.php --fail-on-change"
+
+  update-docs:
+    usage: Lint docs.
+    cmd: ahoy cli "php docs.php"
+
   test-bdd:
     usage: Run BDD tests.
     cmd: ahoy cli "cd /app/build && vendor/bin/behat -c /app/behat.yml --strict --colors $@"

diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -29,6 +29,10 @@ jobs:
           name: Lint code
           command: ahoy lint || [ "${CI_LINT_IGNORE_FAILURE:-0}" -eq 1 ]
 
+      - run:
+          name: Lint documentation
+          command: ahoy lint-docs || [ "${CI_LINT_DOCS_IGNORE_FAILURE:-0}" -eq 1 ]
+
       - run:
           name: Run tests with coverage
           command: ahoy test-bdd-coverage || [ "${CI_TEST_IGNORE_FAILURE:-0}" -eq 1 ]

diff --git a/MIGRATION.md b/MIGRATION.md
@@ -4,7 +4,7 @@ A migration map of the step definitions available in v2 to v3.
 
 | V2                                                                                                                           | V3                                                                                                                                                                                                                             |
 |------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **[`DraggableViewsTrait`](src/DraggableViewsTrait.php) ([example](tests/behat/features/draggableviews.feature))**            |                                                                                                                                                                                                                                |
+| **[`DraggableviewsTrait`](src/DraggableviewsTrait.php) ([example](tests/behat/features/draggableviews.feature))**            |                                                                                                                                                                                                                                |
 | `Then I save draggable views :view_id view :views_display_id display :bundle items in the following order:`                  | `When I save the draggable views items of the view :view_id and the display :views_display_id for the :bundle content in the following order:`                                                                                 |
 | &nbsp;                                                                                                                       |                                                                                                                                                                                                                                |
 | **[`EckTrait`](src/EckTrait.php) ([example](tests/behat/features/eck.feature))**                                             |                                                                                                                                                                                                                                |
@@ -24,7 +24,7 @@ A migration map of the step definitions available in v2 to v3.
 | `Given I press the :char key`                                                                                                | `When I press the key :char`                                                                                                                                                                                                   |
 | `Given I press the :char key on :selector`                                                                                   | `When I press the key :char on the element :selector`                                                                                                                                                                          |
 | &nbsp;                                                                                                                       |                                                                                                                                                                                                                                |
-| **[`MetaTagTrait`](src/MetaTagTrait.php) ([example](tests/behat/features/metatag.feature))**                                 |                                                                                                                                                                                                                                |
+| **[`MetatagTrait`](src/MetatagTrait.php) ([example](tests/behat/features/metatag.feature))**                                 |                                                                                                                                                                                                                                |
 | `Then I should see a meta tag with the following attributes:`                                                                | `Then the meta tag should exist with the following attributes:`                                                                                                                                                                |
 | `Then I should not see a meta tag with the following attributes:`                                                            | `Then the meta tag should not exist with the following attributes:`                                                                                                                                                            |
 | &nbsp;                                                                                                                       |                                                                                                                                                                                                                                |