chore(doc): reorganize documentation structure

jolicode · Mar 21, 2024 · 75154fe · 75154fe
1 parent 472649f
commit 75154fe
Show file tree

Hide file tree

Showing 23 changed files with 514 additions and 235 deletions.
diff --git a/docs/_nav.md b/docs/_nav.md
@@ -1,3 +1,20 @@
-- [Quick start](index.md)
-- [With Symfony](symfony.md)
+- [Home](index.md)
+- [Getting started](getting-started/index.md)
+    - [Understanding the `source` and `target`](getting-started/source-and-target.md)
+    - [Using the context](getting-started/context.md)
+    - [Configuration](getting-started/configuration.md)
+    - [Cache and Loaders](getting-started/loader.md)
+- [Mapping](mapping/index.md)
+    - [MapTo and MapFrom attributes](mapping/attributes.md)
+    - [Ignoring properties](mapping/ignoring-properties.md)
+    - [Conditional mapping](mapping/conditional-mapping.md)
+    - [Groups](mapping/groups.md)
+    - [Transformer](mapping/transformer.md)
+    - [Symfony Serializer](mapping/serializer.md)
+    - [Mapping inheritance](mapping/inheritance.md)
+- [Symfony Bundle](bundle/index.md)
+    - [Installation](bundle/installation.md)
+    - [Configuration](bundle/configuration.md)
+    - [Expression Language](bundle/expression-language.md)
+- [Upgrading to 9.0](upgrading-9.0.md)
 - [Contributing](contributing.md)
diff --git a/docs/bundle/configuration.md b/docs/bundle/configuration.md
diff --git a/docs/bundle/expression-language.md b/docs/bundle/expression-language.md
diff --git a/docs/bundle/index.md b/docs/bundle/index.md
@@ -0,0 +1,5 @@
+# Symfony Bundle
+
+- [Installation](installation.md)
+- [Configuration](configuration.md)
+- [Expression Language](expression-language.md)
diff --git a/docs/bundle/installation.md b/docs/bundle/installation.md
diff --git a/docs/configuration.md b/docs/configuration.md
diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -0,0 +1,24 @@
+# Getting started with AutoMapper
+
+## Understanding the `source` and `target`
+
+The `source` and `target` are the most important concepts in AutoMapper. 
+
+The `source` is the object or data that you want to map from. 
+The `target` is the object or data that you want to map to.
+
+When using the `map` method, the `source` must be the data
+
+### Mapper: Object to Object
+
+### Serialization or Normalization : Object to Array
+
+### Deserialization or Denormalization : Array to Object
+
+## Configuration
+
+### Runtime Configuration
+
+### Generator Configuration
+
+## Next Steps
diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md
diff --git a/docs/getting-started/context.md b/docs/getting-started/context.md
diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md
@@ -0,0 +1,6 @@
+# Getting started
+
+- [Understanding the `source` and `target`](source-and-target.md)
+- [Using the context](context.md)
+- [Configuration](configuration.md)
+- [Cache and Loaders](loader.md)
diff --git a/docs/getting-started/loader.md b/docs/getting-started/loader.md
diff --git a/docs/getting-started/source-and-target.md b/docs/getting-started/source-and-target.md