Merge pull request #196 from TomHAnderson/feature/technical-docs

TomHAnderson · web-flow · commit 9d0e88eaa5d4 · 2026-01-24T14:41:31.000-07:00
Added footer to tech docs
diff --git a/docs/footer.rst b/docs/footer.rst
@@ -3,6 +3,9 @@
 
 This is documentation for
 `API-Skeletons/doctrine-orm-graphql <https://github.com/API-Skeletons/doctrine-orm-graphql>`_.
+
+There is also `technical documentation <technical/index.html>`_ available.
+
 Please add your ★ star to the project.
 
 Authored by `API Skeletons <https://apiskeletons.com>`_.
diff --git a/docs/technical/COMPLETE.rst b/docs/technical/COMPLETE.rst
@@ -231,3 +231,8 @@ This comprehensive technical documentation provides:
 - Migration guide
 
 Everything an experienced PHP developer needs to master the Doctrine ORM GraphQL library.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/README.rst b/docs/technical/README.rst
@@ -291,3 +291,8 @@ License
 =======
 
 This documentation is part of the Doctrine ORM GraphQL library and is licensed under the MIT License.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/advanced-topics.rst b/docs/technical/advanced-topics.rst
@@ -361,3 +361,8 @@ Best Practices
 7. **Monitor Production**: Log slow queries and errors
 
 For more details, see :doc:`performance` and :doc:`architecture`.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/architecture.rst b/docs/technical/architecture.rst
@@ -1031,3 +1031,8 @@ The library provides multiple extension points:
 6. **Metadata Manipulation**: Modify via Metadata event
 
 See :doc:`advanced-topics` for detailed examples.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/attributes-reference.rst b/docs/technical/attributes-reference.rst
@@ -1180,3 +1180,8 @@ The attribute system provides flexible, declarative configuration for GraphQL sc
 - Provide descriptions for better documentation
 
 For advanced customization beyond attributes, see :doc:`advanced-topics` and :doc:`events-reference`.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/config-reference.rst b/docs/technical/config-reference.rst
@@ -870,3 +870,8 @@ Common Pitfalls
 4. **Cache Always On**: ``useHydratorCache`` and ``useQueryResultCache`` waste memory for simple queries
 5. **Empty entityPrefix**: Results in ugly type names like ``App_Entity_Artist_default``
 6. **Forgetting ignoreFields**: Exposes sensitive data with ``globalEnable``
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/driver-reference.rst b/docs/technical/driver-reference.rst
@@ -895,3 +895,8 @@ Performance Tips
 5. **Lazy Initialization**: Driver services are lazy-loaded, so creating multiple drivers is cheap
 
 See :doc:`performance` for detailed optimization strategies.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/events-reference.rst b/docs/technical/events-reference.rst
@@ -307,3 +307,8 @@ Events provide powerful customization points:
 - **Metadata**: Programmatic metadata modifications
 
 For more examples, see :doc:`advanced-topics`.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/filters-reference.rst b/docs/technical/filters-reference.rst
@@ -1165,3 +1165,8 @@ For maximum performance:
 - Use full-text search for text searching
 
 For additional customization, see :doc:`events-reference` and :doc:`advanced-topics`.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/footer.rst b/docs/technical/footer.rst
@@ -0,0 +1,11 @@
+
+----------
+
+This is technical documentation for
+`API-Skeletons/doctrine-orm-graphql <https://github.com/API-Skeletons/doctrine-orm-graphql>`_.
+
+There is also `user documentation <../index.html>`_ available.
+
+Please add your ★ star to the project.
+
+Authored by `API Skeletons <https://apiskeletons.com>`_.
diff --git a/docs/technical/index.rst b/docs/technical/index.rst
@@ -324,3 +324,8 @@ About This Documentation
 This comprehensive developer guide was created to provide in-depth technical documentation for experienced PHP developers working with the Doctrine ORM GraphQL library. It covers architecture, implementation details, performance considerations, and advanced usage patterns.
 
 For user-focused documentation, see the official documentation at https://doctrine-orm-graphql.apiskeletons.dev
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/migration-guide.rst b/docs/technical/migration-guide.rst
@@ -538,3 +538,8 @@ Key migration points:
 5. Test thoroughly
 
 Performance benefits are automatic after migration!
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/performance.rst b/docs/technical/performance.rst
@@ -917,3 +917,8 @@ The library has been heavily optimized for performance, with database-level filt
 For most applications, the current optimizations are sufficient. Only consider additional optimizations (batch loading, aggressive caching, etc.) if profiling shows specific bottlenecks.
 
 Remember: **Measure first, optimize second**. Use profiling tools to identify actual bottlenecks before implementing complex optimizations.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
diff --git a/docs/technical/types-reference.rst b/docs/technical/types-reference.rst
@@ -211,3 +211,8 @@ Retrieval
     $emailType = $driver->type('email');
 
 For complete documentation, see :doc:`driver-reference` and :doc:`architecture`.
+
+.. role:: raw-html(raw)
+   :format: html
+
+.. include:: footer.rst
