Skip to content

Commit 12d73ad

Browse files
committed
Updated docs
1 parent 61d9a58 commit 12d73ad

5 files changed

Lines changed: 21 additions & 31 deletions

File tree

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,26 @@ Documentation
4646
Full documentation is available at https://doctrine-orm-graphql.apiskeletons.dev or in the [docs](https://github.com/api-skeletons/doctrine-orm-graphql/blob/master/docs) directory.
4747

4848

49-
Versions
49+
Features
5050
--------
5151

52-
* 12.x - Supports [league/event](https://github.com/thephpleague/event) version 3.0 and is PSR-14 compliant
53-
* 11.x - Supports [league/event](https://github.com/thephpleague/event) version 2.2
52+
* Supports all [Doctrine Types](https://doctrine-orm-graphql.apiskeletons.dev/en/latest/types.html#data-type-mappings) and allows custom types
53+
* Pagination with the [GraphQL Complete Connection Model](https://graphql.org/learn/pagination/#complete-connection-model)
54+
* [Filtering of sub-collections](https://doctrine-orm-graphql.apiskeletons.dev/en/latest/queries.html)
55+
* [Events](https://github.com/API-Skeletons/doctrine-orm-graphql#events) for modifying queries, entity types and more
56+
* [Multiple configuration group support](https://doctrine-orm-graphql.apiskeletons.dev/en/latest/driver.html#group)
57+
5458

55-
More information [in the documentation](https://doctrine-orm-graphql.apiskeletons.dev/en/latest/versions.html).
59+
Technical Features
60+
------------------
61+
62+
* Attribute-based metadata
63+
* PHP 8.4 Lazy Ghost Objects for deferred type initialization
64+
* PSR-14 Event-Driven Architecture for query and type customization
65+
* Custom PSR-11 Container with lazy initialization and buildable types
66+
* Advanced hydration system with Doctrine Laminas Hydrator and extraction strategies
67+
* Dynamic QueryBuilder generation with filter translation and event-driven query modification
68+
to solve N+1 query problems
5669

5770

5871
Examples
@@ -63,16 +76,6 @@ The **LDOG Stack**: Laravel, Doctrine ORM, and GraphQL uses this library: https
6376
For an working implementation see https://graphql.lcdb.org
6477

6578

66-
Features
67-
--------
68-
69-
* Supports all [Doctrine Types](https://doctrine-orm-graphql.apiskeletons.dev/en/latest/types.html#data-type-mappings) and allows custom types
70-
* Pagination with the [GraphQL Complete Connection Model](https://graphql.org/learn/pagination/#complete-connection-model)
71-
* [Filtering of sub-collections](https://doctrine-orm-graphql.apiskeletons.dev/en/latest/queries.html)
72-
* [Events](https://github.com/API-Skeletons/doctrine-orm-graphql#events) for modifying queries, entity types and more
73-
* [Multiple configuration group support](https://doctrine-orm-graphql.apiskeletons.dev/en/latest/driver.html#group)
74-
75-
7679
Quick Start
7780
-----------
7881

@@ -277,7 +280,10 @@ You may [exclude any filter](https://doctrine-orm-graphql.apiskeletons.dev/en/la
277280
History
278281
-------
279282

280-
The roots of this project go back to May 2018 with https://github.com/API-Skeletons/zf-doctrine-graphql; written for Zend Framework 2. It was migrated to the framework agnostic https://packagist.org/packages/api-skeletons/doctrine-graphql but the name of that repository was incorrect because it did not specify ORM only. So this repository was created and the others were abandoned.
283+
The roots of this project go back to May 2018 with https://github.com/API-Skeletons/zf-doctrine-graphql; written for
284+
Zend Framework 2. It was migrated to the framework agnostic
285+
https://packagist.org/packages/api-skeletons/doctrine-graphql but the name of that repository was incorrect
286+
because it did not specify ORM only. So this repository was created and the others were abandoned.
281287

282288
This was written for the [Live Concert Database](https://lcdb.org)
283289

docs/events.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
Events
33
======
44

5-
There are two versions, 11 and 12, of this library which support different event
6-
manager versions. See `Versions and Event Manager Support <versions.html>`_ for
7-
more information.
8-
95
Query Builder Event
106
===================
117

docs/index.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,6 @@ you'll see, there's a lot of customizable power built in too.
7979
technical/internals
8080
technical/migration-guide
8181

82-
.. toctree::
83-
:maxdepth: 1
84-
:caption: Reference
85-
86-
technical/api-index
87-
technical/changelog
8882

8983
.. role:: raw-html(raw)
9084
:format: html

docs/technical/index.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -246,12 +246,6 @@ Documentation Structure
246246
internals
247247
migration-guide
248248

249-
.. toctree::
250-
:maxdepth: 1
251-
:caption: Reference
252-
253-
api-index
254-
changelog
255249

256250
Conventions Used
257251
================

testdatabase.sqlite

-124 KB
Binary file not shown.

0 commit comments

Comments
 (0)