Restructuring part 2

jim-parry · jim-parry · commit 3ba1b219e3dc · 2018-09-25T02:13:17.000-07:00
diff --git a/user_guide_src/source/cli/cli.rst b/user_guide_src/source/cli/cli.rst
@@ -102,4 +102,4 @@ The CLI library makes working with the CLI interface simple.
 It provides easy ways to output text in multiple colors to the terminal window. It also
 allows you to prompt a user for information, making it easy to build flexible, smart tools.
 
-See the :doc:`CLI Library </libraries/cli>` page for detailed information.
+See the :doc:`CLI Library </cli/cli_library>` page for detailed information.
diff --git a/user_guide_src/source/cli/cli_commands.rst b/user_guide_src/source/cli/cli_commands.rst
@@ -120,7 +120,7 @@ Then **foo** is the command name, and the ``$params`` array would be::
 
     $params = ['bar', 'baz'];
 
-This can also be accessed through the :doc:`CLI </libraries/cli>` library, but this already has your command removed
+This can also be accessed through the :doc:`CLI </cli/cli_library>` library, but this already has your command removed
 from the string. These parameters can be used to customize how your scripts behave.
 
 Our demo command might have a ``run`` method something like::
diff --git a/user_guide_src/source/cli/cli_library.rst b/user_guide_src/source/cli/cli_library.rst
diff --git a/user_guide_src/source/cli/index.rst b/user_guide_src/source/cli/index.rst
@@ -0,0 +1,12 @@
+##################
+Command Line Usage
+##################
+
+CodeIgniter 4 can also be used with command line programs.
+
+.. toctree::
+    :titlesonly:
+
+    cli
+    cli_commands
+    cli_library
diff --git a/user_guide_src/source/concepts/mvc.rst b/user_guide_src/source/concepts/mvc.rst
@@ -63,7 +63,7 @@ miss updating an area.
 
 Models are typically stored in **/application/Models**, though they can use a namespace to be grouped however you need.
 
-:doc:`Find out more about models </database/model>`
+:doc:`Find out more about models </models/model>`
 
 Controllers
 ===========
diff --git a/user_guide_src/source/database/events.rst b/user_guide_src/source/database/events.rst
@@ -2,7 +2,7 @@
 Database Events
 ###############
 
-The Database classes contain a few :doc:`Events </general/events>` that you can tap into in
+The Database classes contain a few :doc:`Events </extending/events>` that you can tap into in
 order to learn more about what is happening during the database execution. These events can
 be used to collect data for analysis and reporting. The :doc:`Debug Toolbar </testing/debugging>`
 uses this to collect the queries to display in the Toolbar.
diff --git a/user_guide_src/source/database/index.rst b/user_guide_src/source/database/index.rst
@@ -1,6 +1,6 @@
-#############
-Managing Data
-#############
+######################
+Working With Databases
+######################
 
 CodeIgniter comes with a full-featured and very fast abstracted database
 class that supports both traditional structures and Query Builder
@@ -19,9 +19,4 @@ patterns. The database functions offer clear, simple syntax.
     Transactions <transactions>
     Getting MetaData <metadata>
     Custom Function Calls <call_function>
-    Using CodeIgniter's Model <model>
-    Using Entity Classes <entities>
-    Database Manipulation with Database Forge <forge>
-    Database Migrations <migration>
-    Database Seeding <seeds>
     Database Events <events>
diff --git a/user_guide_src/source/dbmgmt/forge.rst b/user_guide_src/source/dbmgmt/forge.rst
diff --git a/user_guide_src/source/dbmgmt/index.rst b/user_guide_src/source/dbmgmt/index.rst
@@ -0,0 +1,12 @@
+##################
+Managing Databases
+##################
+
+CodeIgniter comes with tools to restructure or sees your database.
+
+.. toctree::
+    :titlesonly:
+
+    Database Manipulation with Database Forge <forge>
+    Database Migrations <migration>
+    Database Seeding <seeds>
diff --git a/user_guide_src/source/dbmgmt/migration.rst b/user_guide_src/source/dbmgmt/migration.rst
@@ -176,7 +176,7 @@ to update the schema::
 *******************
 Commnand-Line Tools
 *******************
-CodeIgniter ships with several :doc:`commands </general/cli_commands>` that are available from the command line to help
+CodeIgniter ships with several :doc:`commands </cli/cli_commands>` that are available from the command line to help
 you work with migrations. These tools are not required to use migrations but might make things easier for those of you
 that wish to use them. The tools primarily provide access to the same methods that are available within the MigrationRunner class.
 
diff --git a/user_guide_src/source/dbmgmt/seeds.rst b/user_guide_src/source/dbmgmt/seeds.rst
diff --git a/user_guide_src/source/extending/core_classes.rst b/user_guide_src/source/extending/core_classes.rst
diff --git a/user_guide_src/source/extending/events.rst b/user_guide_src/source/extending/events.rst
diff --git a/user_guide_src/source/extending/index.rst b/user_guide_src/source/extending/index.rst
@@ -0,0 +1,11 @@
+#####################
+Extending CodeIgniter
+#####################
+
+CodeIgniter 4 has been designed to be easy to extend or build upon.
+
+.. toctree::
+    :titlesonly:
+
+    core_classes
+    events
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
@@ -78,7 +78,7 @@ Service Accessors
 
 	Retrieves a locale-specific file based on an alias string.
 
-	For more information, see the :doc:`Localization </libraries/localization>` page.
+	For more information, see the :doc:`Localization </outgoing/localization>` page.
 
 .. php:function:: old( $key[, $default = null, [, $escape = 'html' ]] )
 
diff --git a/user_guide_src/source/general/index.rst b/user_guide_src/source/general/index.rst
@@ -8,14 +8,10 @@ General Topics
     configuration
     urls
     helpers
-    core_classes
-    events
     common_functions
     logging
     errors
     caching
-    cli
-    cli_commands
     modules
     managing_apps
     environments
diff --git a/user_guide_src/source/general/modules.rst b/user_guide_src/source/general/modules.rst
@@ -69,7 +69,7 @@ Many times, you will need to specify the full namespace to files you want to inc
 configured to make integrating modules into your applications simpler by automatically discovering many different
 file types, including:
 
-- :doc:`Events </general/events>`
+- :doc:`Events </extending/events>`
 - :doc:`Registrars </general/configuration>`
 - :doc:`Route files </incoming/routing>`
 - :doc:`Services </concepts/services>`
diff --git a/user_guide_src/source/incoming/filters.rst b/user_guide_src/source/incoming/filters.rst
@@ -6,7 +6,7 @@ Controller Filters
     :local:
     :depth: 2
 
-Controller Filters allow you to perform actions either before or after the controllers execute. Unlike :doc:`events </general/events>`,
+Controller Filters allow you to perform actions either before or after the controllers execute. Unlike :doc:`events </extending/events>`,
 you can very simply choose which URI's in your application have the filters applied to them. Incoming filters may
 modify the Request, while after filters can act on and even modify the Response, allowing for a lot of flexibility
 and power. Some common examples of tasks that might be performed with filters are:
diff --git a/user_guide_src/source/incoming/index.rst b/user_guide_src/source/incoming/index.rst
@@ -1,6 +1,6 @@
-#################
-Handling Requests
-#################
+#######################
+Controllers and Routing
+#######################
 
 Controllers handle incoming requests.
 
diff --git a/user_guide_src/source/incoming/routing.rst b/user_guide_src/source/incoming/routing.rst
@@ -65,10 +65,10 @@ The following placeholders are available for you to use in your routes:
 * **(:num)** will match any integer.
 * **(:alpha)** will match any string of alphabetic characters
 * **(:alphanum)** will match any string of alphabetic characters or integers, or any combination of the two.
-* **(:hash)** is the same as **:segment**, but can be used to easily see which routes use hashed ids (see the :doc:`Model </database/model>` docs).
+* **(:hash)** is the same as **:segment**, but can be used to easily see which routes use hashed ids (see the :doc:`Model </models/model>` docs).
 
 .. note:: **{locale}** cannot be used as a placeholder or other part of the route, as it is reserved for use
-    in :doc:`localization </libraries/localization>`.
+    in :doc:`localization </outgoing/localization>`.
 
 Examples
 ========
diff --git a/user_guide_src/source/index.rst b/user_guide_src/source/index.rst
@@ -8,9 +8,9 @@ CodeIgniter4 User Guide
 
         intro/index
 
-************
-Installation
-************
+***************
+Getting Started
+***************
 
 .. toctree::
 	:includehidden:
@@ -19,10 +19,6 @@ Installation
 
 	installation/index
 
-********
-Tutorial
-********
-
 .. toctree::
 	:includehidden:
 	:titlesonly:
@@ -32,6 +28,7 @@ Tutorial
 *************************
 Overview & General Topics
 *************************
+
 .. toctree::
 	:titlesonly:
 
@@ -42,15 +39,24 @@ Overview & General Topics
 
 	general/index
 
-***************************
-Controllers, Models & Views
-***************************
+****************
+Request Handling
+****************
 
 .. toctree::
 	:titlesonly:
 
 	incoming/index
 
+.. toctree::
+	:titlesonly:
+
+	outgoing/index
+
+******************
+Handling Databases
+******************
+
 .. toctree::
 	:titlesonly:
 
@@ -59,7 +65,13 @@ Controllers, Models & Views
 .. toctree::
 	:titlesonly:
 
-	outgoing/index
+	models/index
+
+.. toctree::
+	:titlesonly:
+
+	dbmgmt/index
+
 
 *******************
 Libraries & Helpers
@@ -75,15 +87,25 @@ Libraries & Helpers
 
 	helpers/index
 
-*******************
-Testing & Debugging
-*******************
+***************
+Advanced Topics
+***************
 
 .. toctree::
 	:titlesonly:
 
 	testing/index
 
+.. toctree::
+	:titlesonly:
+
+	cli/index
+
+.. toctree::
+	:titlesonly:
+
+	extending/index
+
 .. toctree::
         :hidden:
 
diff --git a/user_guide_src/source/libraries/index.rst b/user_guide_src/source/libraries/index.rst
@@ -5,15 +5,12 @@ Library Reference
 .. toctree::
     :titlesonly:
 
-    benchmark
     caching
-    cli
     curlrequest
     email
     files
     honeypot
     images
-    localization
     pagination
     security
     sessions
diff --git a/user_guide_src/source/libraries/pagination.rst b/user_guide_src/source/libraries/pagination.rst
@@ -19,7 +19,7 @@ Paginating Database Results
 ***************************
 
 In most cases, you will be using the Pager library in order to paginate results that you retrieve from the database.
-When using the :doc:`Model </database/model>` class, you can use its built-in ``paginate()`` method to automatically
+When using the :doc:`Model </models/model>` class, you can use its built-in ``paginate()`` method to automatically
 retrieve the current batch of results, as well as setup the Pager library so it's ready to use in your controllers.
 It even reads the current page it should display from the current URL via a ``page=X`` query variable.
 
diff --git a/user_guide_src/source/libraries/validation.rst b/user_guide_src/source/libraries/validation.rst
@@ -196,7 +196,7 @@ This automatically loads the ``Config\Validation`` file which contains settings
 for including multiple Rule sets, and collections of rules that can be easily reused.
 
 .. note:: You may never need to use this method, as both the :doc:`Controller </incoming/controllers>` and
-    the :doc:`Model </database/model>` provide methods to make validation even easier.
+    the :doc:`Model </models/model>` provide methods to make validation even easier.
 
 Setting Validation Rules
 ========================
diff --git a/user_guide_src/source/models/entities.rst b/user_guide_src/source/models/entities.rst
@@ -4,7 +4,7 @@ Working With Entities
 
 CodeIgniter supports Entity classes as a first-class citizen in it's database layer, while keeping
 them completely optional to use. They are commonly used as part of the Repository pattern, but can
-be used directly with the :doc:`Model </database/model>` if that fits your needs better.
+be used directly with the :doc:`Model </models/model>` if that fits your needs better.
 
 .. contents::
     :local:
diff --git a/user_guide_src/source/models/index.rst b/user_guide_src/source/models/index.rst
@@ -0,0 +1,12 @@
+#############
+Modeling Data
+#############
+
+CodeIgniter comes with rich tools for modeling and working
+with your database tables and records.
+
+.. toctree::
+    :titlesonly:
+
+    Using CodeIgniter's Model <model>
+    Using Entity Classes <entities>
diff --git a/user_guide_src/source/models/model.rst b/user_guide_src/source/models/model.rst
@@ -370,7 +370,7 @@ model's ``save()`` method to inspect the class, grab any public and private prop
 	// Save the changes
 	$model->save($job);
 
-.. note:: If you find yourself working with Entities a lot, CodeIgniter provides a built-in :doc:`Entity class </database/entities>`
+.. note:: If you find yourself working with Entities a lot, CodeIgniter provides a built-in :doc:`Entity class </models/entities>`
 	that provides several handy features that make developing Entities simpler.
 
 Deleting Data
diff --git a/user_guide_src/source/outgoing/index.rst b/user_guide_src/source/outgoing/index.rst
@@ -1,6 +1,6 @@
-############
-Presentation
-############
+##################
+Building Responses
+##################
 
 View components are used to build what is returned to the user.
 
@@ -11,4 +11,5 @@ View components are used to build what is returned to the user.
     view_cells
     view_renderer
     view_parser
+    localization
     alternative_php
diff --git a/user_guide_src/source/outgoing/localization.rst b/user_guide_src/source/outgoing/localization.rst
diff --git a/user_guide_src/source/testing/benchmark.rst b/user_guide_src/source/testing/benchmark.rst
diff --git a/user_guide_src/source/testing/debugging.rst b/user_guide_src/source/testing/debugging.rst
@@ -106,7 +106,7 @@ Setting Benchmark Points
 
 In order for the Profiler to compile and display your benchmark data you must name your mark points using specific syntax.
 
-Please read the information on setting Benchmark points in the :doc:`Benchmark Library </libraries/benchmark>` page.
+Please read the information on setting Benchmark points in the :doc:`Benchmark Library </testing/benchmark>` page.
 
 Creating Custom Collectors
 ==========================
diff --git a/user_guide_src/source/testing/index.rst b/user_guide_src/source/testing/index.rst
@@ -12,4 +12,5 @@ The following sections should get you quickly testing your applications.
     Database <database>
     Controller Testing <controllers>
     HTTP Testing <feature>
+    benchmark
     debugging
diff --git a/user_guide_src/source/tutorial/news_section.rst b/user_guide_src/source/tutorial/news_section.rst
@@ -38,8 +38,8 @@ library. This will make the database class available through the
 Before querying the database, a database schema has to be created.
 Connect to your database and run the SQL command below (MySQL).
 Also add some seed records. For now, we'll just show you the query needed
-to create the table, but you should read about :doc:`Migrations <../database/migration>`
-and :doc:`Seeds <../database/seeds>` to create more useful database setups.
+to create the table, but you should read about :doc:`Migrations <../dbmgmt/migration>`
+and :doc:`Seeds <../dbmgmt/seeds>` to create more useful database setups.
 
 ::
 
