Merge pull request laravel-doctrine#594 from TomHAnderson/doc/proof1

3.0 docs proof 1

Author: TomHAnderson

docs/configuration.rst

@@ -292,7 +292,7 @@ Config settings
 * ``cache.query`` - Cache transformation of a DQL query to its SQL counterpart.
 * ``cache.result`` - The result cache can be used to cache the results of your
 * queries so you don't have to query the database or hydrate the data again
-* after the first time.
+  after the first time.
 
 Gedmo
 =====

docs/entities.rst

@@ -29,6 +29,9 @@ with properties and getters and setters.
 Generally the properties are protected or private, so they only can be accessed
 through getters and setters.
 
+However, with property hooks in 8.4, entities composed of gloal properties only
+may become the norm.
+
 The domain/business logic is completely separated from the persistence logic.
 This means we have to tell Doctrine how it should map the columns from the
 database to our Entity class. In this example we are using annotations.
@@ -47,8 +50,6 @@ You can easily add on new relations with ``->add()``, remove them with
 The ``Scientist`` entity used in the example above looks like this when using
 annotations for the meta data.
 
-    Coding note:  Thanks to property hooks in PHP 8.4, getters and setters may
-    no longer be necessary.
 
 .. code-block:: php
 

docs/index.rst

@@ -6,6 +6,8 @@ Laravel Doctrine ORM
    :align: center
    :scale: 25 %
 
+This is the documentation for `laravel-doctrine/orm <https://github.com/laravel-doctrine/orm>`_
+
 An integration library for Laravel and Doctrine ORM.
 Version 3 of this library supports Laravel 10+,
 Doctrine ORM ^3.0, and Doctrine DBAL ^4.0.
@@ -51,23 +53,6 @@ object-oriented programming if persistence and entities are seperate.
   pagination
 
 
-Features
---------
-
-* Easy configuration
-* Pagination
-* Preconfigured metadata, connections and caching
-* Extendable: extend or add your own drivers for metadata, connections or cache
-* Change metadata, connection or cache settings easy with a resolved hook
-* Annotations, yaml, xml, config and static php meta data mappings
-* Multiple entity managers and connections
-* Laravel naming strategy
-* Simple authentication implementation
-* Password reminders implementation
-* Doctrine console commands
-* DoctrineExtensions supported
-* Timestamps, Softdeletes and TablePrefix listeners
-
 .. role:: raw-html(raw)
    :format: html
 

docs/metadata.rst

@@ -2,7 +2,7 @@
 Metadata
 ========
 
-Because Doctrine entities dont extend any smart base class, we have to tell
+Because Doctrine entities do not extend any smart ancestor class, we have to tell
 Doctrine how to map the data from the database into the entity. There are
 multiple ways of doing this.
 
@@ -65,26 +65,27 @@ App.Entities.Article.dcm.xml
 
 .. code-block:: xml
 
-<?xml version="1.0" encoding="UTF-8"?>
-<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
-      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-      xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
-                          http://raw.github.com/doctrine/doctrine2/master/doctrine-mapping.xsd">
-
-    <entity name="App\Entities\Article" table="articles">
-        <id name="id" type="integer" column="id">
-            <generator strategy="AUTO"/>
-            <sequence-generator sequence-name="tablename_seq" allocation-size="100" initial-value="1" />
-        </id>
-        <field name="title" column="title" type="string" />
-    </entity>
-</doctrine-mapping>
-```
+  <?xml version="1.0" encoding="UTF-8"?>
+  <doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
+                            http://raw.github.com/doctrine/doctrine2/master/doctrine-mapping.xsd">
+
+      <entity name="App\Entities\Article" table="articles">
+          <id name="id" type="integer" column="id">
+              <generator strategy="AUTO"/>
+              <sequence-generator sequence-name="tablename_seq" allocation-size="100" initial-value="1" />
+          </id>
+          <field name="title" column="title" type="string" />
+      </entity>
+  </doctrine-mapping>
+
 
 More information about XML mappings:
 https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/xml-mapping.html
 
-### Config files
+Config files
+------------
 
 This package adds another option, which leverages Laravel's config system.
 In addition to setting `meta`, this also requires setting `mapping_file`.