Fine-tuning for path, config, and layout

Author: chr-hertel

.github/workflows/docs.yml

@@ -31,5 +31,5 @@ jobs:
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./build/docs
+          publish_dir: ./.phpdoc/build
           enable_jekyll: false

.gitignore

@@ -11,6 +11,5 @@ tests/Conformance/sessions
 tests/Conformance/logs/*.log
 
 # phpDocumentor
-build/
+.phpdoc/build/
 .phpdoc/cache/
-phpDocumentor.phar

.phpdoc/template/base.html.twig

@@ -2,7 +2,12 @@
 
 {% set topMenu = {
     "menu": [
-        { "name": "Guides", "url": "guide/docs/index.html"}
+        { "name": "Guides", "url": "docs/index.html"},
+        { "name": "Specification", "url": "https://modelcontextprotocol.io/" }
+    ],
+    "social": [
+        { "iconClass": "fab fa-github", "url": "https://github.com/modelcontextprotocol/php-sdk"},
+        { "iconClass": "fab fa-discord", "url": "https://discord.gg/6CSzBmMkjX"}
     ]
 }
 %}

.phpdoc/template/components/header-title.html.twig

@@ -0,0 +1,10 @@
+<h1 class="phpdocumentor-title">
+    <a href="{{ path('/docs/index.html') }}" class="phpdocumentor-title__link">
+        <svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 195 195" fill="none">
+            <path d="M25 97.8528L92.8823 29.9706C102.255 20.598 117.451 20.598 126.823 29.9706V29.9706C136.196 39.3431 136.196 54.5391 126.823 63.9117L75.5581 115.177" stroke="black" stroke-width="12" stroke-linecap="round"/>
+            <path d="M76.2653 114.47L126.823 63.9117C136.196 54.5391 151.392 54.5391 160.765 63.9117L161.118 64.2652C170.491 73.6378 170.491 88.8338 161.118 98.2063L99.7248 159.6C96.6006 162.724 96.6006 167.789 99.7248 170.913L112.331 183.52" stroke="black" stroke-width="12" stroke-linecap="round"/>
+            <path d="M109.853 46.9411L59.6482 97.1457C50.2757 106.518 50.2757 121.714 59.6482 131.087V131.087C69.0208 140.459 84.2168 140.459 93.5894 131.087L143.794 80.8822" stroke="black" stroke-width="12" stroke-linecap="round"/>
+        </svg>
+        <span style="margin-left: 0.25em;">{{ project.name }}</span>
+    </a>
+</h1>

Makefile

@@ -39,5 +39,5 @@ ci-lowest: deps-low cs phpstan tests
 
 docs:
 	vendor/bin/phpdoc
-	@grep -q 'No errors have been found' build/docs/reports/errors.html || \
+	@grep -q 'No errors have been found' .phpdoc/build/reports/errors.html || \
 		(echo "Documentation errors found. See build/docs/reports/errors.html" && exit 1)

docs/index.md

@@ -1,7 +1,7 @@
 # MCP PHP SDK Guides
 
-- [MCP Elements](mcp-elements.html) — Core capabilities (Tools, Resources, Resource Templates, and Prompts) with registration methods.
-- [Server Builder](server-builder.html) — Fluent builder class for creating and configuring MCP server instances.
-- [Transports](transports.html) — STDIO and HTTP transport implementations with guidance on choosing between them.
-- [Client Communication](client-communication.html) — Methods for servers to communicate back to clients: sampling, logging, progress, and notifications.
-- [Examples](examples.html) — Example projects demonstrating attribute-based discovery, dependency injection, HTTP transport, and more.
+- [MCP Elements](mcp-elements.md) — Core capabilities (Tools, Resources, Resource Templates, and Prompts) with registration methods.
+- [Server Builder](server-builder.md) — Fluent builder class for creating and configuring MCP server instances.
+- [Transports](transports.md) — STDIO and HTTP transport implementations with guidance on choosing between them.
+- [Server-Client Communication](server-client-communication.md) — Methods for servers to communicate back to clients: sampling, logging, progress, and notifications.
+- [Examples](examples.md) — Example projects demonstrating attribute-based discovery, dependency injection, HTTP transport, and more.

docs/client-communication.md docs/server-client-communication.mddocs/client-communication.md renamed to docs/server-client-communication.md

@@ -7,10 +7,11 @@
 >
     <title>MCP PHP SDK</title>
     <paths>
-        <output>build/docs</output>
+        <output>.phpdoc/build</output>
     </paths>
     <version number="latest">
-        <api>
+        <folder>latest</folder>
+        <api ignore-packages="true">
             <source dsn=".">
                 <path>src</path>
             </source>
@@ -19,14 +20,25 @@
                 <path>vendor/**/*</path>
                 <path>tests/**/*</path>
             </ignore>
+            <ignore-tags>
+                <ignore-tag>phpstan-type</ignore-tag>
+                <ignore-tag>phpstan-type-import</ignore-tag>
+                <ignore-tag>template</ignore-tag>
+                <ignore-tag>template-covariant</ignore-tag>
+                <ignore-tag>template-extends</ignore-tag>
+                <ignore-tag>template-implements</ignore-tag>
+                <ignore-tag>extends</ignore-tag>
+                <ignore-tag>implements</ignore-tag>
+            </ignore-tags>
         </api>
         <guide format="md">
             <source dsn=".">
                 <path>docs</path>
             </source>
-            <output>guide</output>
+            <output>/</output>
         </guide>
     </version>
     <setting name="guides.enabled" value="true"/>
-    <setting name="graphs.enabled" value="true"/>
+    <setting name="graphs.enabled" value="false"/>
+    <setting name="template.color" value="black"/>
 </phpdocumentor>