Move examples into docs (zircote#1719)

Author: DerManoMann

.github/workflows/gh-pages.yml

@@ -27,11 +27,6 @@ jobs:
       - name: Install vitepress and deps
         run: cd docs && npm install
 
-      - name: Add examples
-        run: |
-          cp -r examples docs
-          rm docs/examples/Readme.md
-
       - name: Build site
         run: composer docs:build
 

docs/.vitepress/config.js

@@ -57,11 +57,13 @@ function getReferenceSidebar() {
   ]
 }
 
-
 module.exports = {
   title: "Swagger-PHP",
   base: "/swagger-php/",
   description: "Generate OpenAPI documentation for your RESTful API.",
+  srcExclude: [
+      'examples/Readme.md'
+  ],
   themeConfig: {
     repo: 'zircote/swagger-php',
     docsDir: 'docs',

examples/Readme.md docs/examples/Readme.md

@@ -4,13 +4,13 @@ parameters:
 			message: '#^Property OpenApi\\Annotations\\AbstractAnnotation\:\:\$x \(array\<string, mixed\>\) does not accept string\.$#'
 			identifier: assign.propertyType
 			count: 1
-			path: examples/processors/schema-query-parameter/SchemaQueryParameter.php
+			path: docs/examples/processors/schema-query-parameter/SchemaQueryParameter.php
 
 		-
 			message: '#^Attribute class JetBrains\\PhpStorm\\ArrayShape does not exist\.$#'
 			identifier: attribute.notFound
 			count: 1
-			path: examples/specs/using-links/attributes/User.php
+			path: docs/examples/specs/using-links/attributes/User.php
 
 		-
 			message: '#^Call to function method_exists\(\) with ReflectionProperty and ''isPromoted'' will always evaluate to true\.$#'

examples/processors/schema-query-parameter/SchemaQueryParameter.php docs/examples/processors/schema-query-parameter/SchemaQueryParameter.php

@@ -7,7 +7,7 @@ parameters:
     paths:
         - src
         - tests
-        - examples
+        - docs/examples
     parallel:
         processTimeout: 300.0
     excludePaths:

examples/processors/schema-query-parameter/app/OpenApi.php docs/examples/processors/schema-query-parameter/app/OpenApi.php

@@ -13,7 +13,7 @@ trait UsesExamples
 {
     public static function examplePath(string $name): string
     {
-        return sprintf('%s/examples/specs/%s', dirname(__DIR__, 2), $name);
+        return sprintf('%s/docs/examples/specs/%s', dirname(__DIR__, 2), $name);
     }
 
     public function getSpecFilename(string $name, string $implementation = 'annotations', string $version = OpenApi::VERSION_3_0_0): string

examples/processors/schema-query-parameter/app/Product.php docs/examples/processors/schema-query-parameter/app/Product.php

@@ -17,7 +17,7 @@ public function __construct($projectRoot)
 
     public function examplePath(string $relativeName): string
     {
-        return $this->projectRoot . '/examples/' . $relativeName;
+        return $this->projectRoot . '/docs/examples/' . $relativeName;
     }
 
     public function collectFiles(string $folder, string $name): array