From 95e5a6a916f9f246f0368dda929db5dc3a5da2e7 Mon Sep 17 00:00:00 2001 From: kenjis Date: Wed, 25 May 2022 16:08:46 +0900 Subject: [PATCH] docs: change directory notation --- user_guide_src/source/concepts/mvc.rst | 2 +- user_guide_src/source/concepts/structure.rst | 26 ++++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/user_guide_src/source/concepts/mvc.rst b/user_guide_src/source/concepts/mvc.rst index 30baafd1a9..3840547de4 100644 --- a/user_guide_src/source/concepts/mvc.rst +++ b/user_guide_src/source/concepts/mvc.rst @@ -28,7 +28,7 @@ the data storage. At their most basic, controllers and models are simply classes that have a specific job. They are not the only class types that you can use, obviously, but they make up the core of how this framework is designed to be used. They even -have designated directories in the **/app** directory for their storage, though you're free to store them +have designated directories in the **app** directory for their storage, though you're free to store them wherever you desire, as long as they are properly namespaced. We will discuss that in more detail below. Let's take a closer look at each of these three main components. diff --git a/user_guide_src/source/concepts/structure.rst b/user_guide_src/source/concepts/structure.rst index 8f948be1cd..e0a754c695 100644 --- a/user_guide_src/source/concepts/structure.rst +++ b/user_guide_src/source/concepts/structure.rst @@ -12,8 +12,8 @@ can change to meet the needs of your application. Default Directories ******************* -A fresh install has five directories: ``/app``, ``/public``, -``/writable``, ``/tests`` and ``/system`` or ``/vendor``. +A fresh install has five directories: ``app/``, ``public/``, +``writable/``, ``tests/`` and ``vendor/`` or ``system/``. Each of these directories has a very specific part to play. app @@ -24,17 +24,17 @@ structure that works well for many applications. The following folders make up t .. code-block:: none - /app - /Config Stores the configuration files - /Controllers Controllers determine the program flow - /Database Stores the database migrations and seeds files - /Filters Stores filter classes that can run before and after controller - /Helpers Helpers store collections of standalone functions - /Language Multiple language support reads the language strings from here - /Libraries Useful classes that don't fit in another category - /Models Models work with the database to represent the business entities. - /ThirdParty ThirdParty libraries that can be used in application - /Views Views make up the HTML that is displayed to the client. + app/ + Config/ Stores the configuration files + Controllers/ Controllers determine the program flow + Database/ Stores the database migrations and seeds files + Filters/ Stores filter classes that can run before and after controller + Helpers/ Helpers store collections of standalone functions + Language/ Multiple language support reads the language strings from here + Libraries/ Useful classes that don't fit in another category + Models/ Models work with the database to represent the business entities + ThirdParty/ ThirdParty libraries that can be used in application + Views/ Views make up the HTML that is displayed to the client Because the ``app`` directory is already namespaced, you should feel free to modify the structure of this directory to suit your application's needs. For example, you might decide to start using the Repository