Skip to content

Commit 560f9bf

Browse files
committed
docs: change text decration and add empty lines
1 parent 036724c commit 560f9bf

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

user_guide_src/source/concepts/structure.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,23 @@ can change to meet the needs of your application.
1212
Default Directories
1313
*******************
1414

15-
A fresh install has five directories: ``app/``, ``public/``,
16-
``writable/``, ``tests/`` and ``vendor/`` or ``system/``.
15+
A fresh install has five directories:
16+
17+
- **app**
18+
- **public**
19+
- **writable**
20+
- **tests**
21+
- **vendor** or **system**
22+
1723
Each of these directories has a very specific part to play.
1824

1925
app
2026
===
2127

22-
The ``app`` directory is where all of your application code lives. This comes with a default directory
23-
structure that works well for many applications. The following folders make up the basic contents:
28+
The **app** directory is where all of your application code lives. This comes with a default directory
29+
structure that works well for many applications.
30+
31+
The following folders make up the basic contents:
2432

2533
.. code-block:: none
2634
@@ -36,19 +44,21 @@ structure that works well for many applications. The following folders make up t
3644
ThirdParty/ ThirdParty libraries that can be used in application
3745
Views/ Views make up the HTML that is displayed to the client
3846
39-
Because the ``app`` directory is already namespaced, you should feel free to modify the structure
40-
of this directory to suit your application's needs. For example, you might decide to start using the Repository
41-
pattern and Entity Models to work with your data. In this case, you could rename the ``Models`` directory to
42-
``Repositories``, and add a new ``Entities`` directory.
47+
Because the **app** directory is already namespaced, you should feel free to modify the structure
48+
of this directory to suit your application's needs.
4349

50+
For example, you might decide to start using the Repository
51+
pattern and Entities to work with your data. In this case, you could rename the **Models** directory to
52+
**Repositories**, and add a new **Entities** directory.
4453

4554
All files in this directory live under the ``App`` namespace, though you are free to change that in
4655
**app/Config/Constants.php**.
4756

4857
system
4958
======
5059

51-
.. note:: If you install CodeIgniter with Composer, the ``system`` is located in ``vendor/codeigniter4/framework/system``.
60+
.. note:: If you install CodeIgniter with Composer, the **system** is located in
61+
**vendor/codeigniter4/framework/system**.
5262

5363
This directory stores the files that make up the framework, itself. While you have a lot of flexibility in how you
5464
use the application directory, the files in the system directory should never be modified. Instead, you should
@@ -74,14 +84,16 @@ writable
7484
========
7585

7686
This directory holds any directories that might need to be written to in the course of an application's life.
77-
This includes directories for storing cache files, logs, and any uploads a user might send. You should add any other
87+
This includes directories for storing cache files, logs, and any uploads a user might send.
88+
89+
You should add any other
7890
directories that your application will need to write to here. This allows you to keep your other primary directories
7991
non-writable as an added security measure.
8092

8193
tests
8294
=====
8395

84-
This directory is set up to hold your test files. The ``_support`` directory holds various mock classes and other
96+
This directory is set up to hold your test files. The **_support** directory holds various mock classes and other
8597
utilities that you can use while writing your tests. This directory does not need to be transferred to your
8698
production servers.
8799

0 commit comments

Comments
 (0)