Merge pull request #605 from kenjis/fix-docs-file-paths

docs: make file paths bold

Author: kenjis

docs/authentication.md

@@ -65,7 +65,7 @@ user_id();
 
 > **Note**
 > The `auth_helper` is autoloaded by Composer. If you want to *override* the functions,
-> you need to define them in `app/Common.php`.
+> you need to define them in **app/Common.php**.
 
 ## Authenticator Responses
 

docs/authorization.md

@@ -50,7 +50,7 @@ group elsewhere, like checking if `$user->inGroup('superadmin')`. By default, th
 ### Default User Group
 
 When a user is first registered on the site, they are assigned to a default user group. This group is defined in
-`app/config/AuthGroups::defaultGroup`, and must match the name of one of the defined groups.
+`Config\AuthGroups::$defaultGroup`, and must match the name of one of the defined groups.
 
 ```php
 public $defaultGroup = 'users';
@@ -132,7 +132,7 @@ if (! $user->hasPermission('users.create')) {
 
 #### Authorizing via Filters
 
-You can restrict access to multiple routes through a [Controller Filter](https://codeigniter.com/user_guide/incoming/filters.html). One is provided for both restricting via groups the user belongs to, as well as which permission they need. The filters are automatically registered with the system under the `group` and `permission` aliases, respectively. You can define the protections within `app/Config/Filters.php`:
+You can restrict access to multiple routes through a [Controller Filter](https://codeigniter.com/user_guide/incoming/filters.html). One is provided for both restricting via groups the user belongs to, as well as which permission they need. The filters are automatically registered with the system under the `group` and `permission` aliases, respectively. You can define the protections within **app/Config/Filters.php**:
 
 ```php
 public $filters = [

docs/events.md

@@ -14,7 +14,7 @@ Shield fires off several events during the lifecycle of the application that you
 
 ## Responding to Events
 
-When you want to respond to an event that Shield publishes, you will need to add it to your `app/Config/Events.php`
+When you want to respond to an event that Shield publishes, you will need to add it to your **app/Config/Events.php**
 file. Each of the following events provides a sample for responding that uses a class and method name.
 Other methods are available. See the [CodeIgniter 4 User Guide](https://codeigniter.com/user_guide/extending/events.html)
 for more information.

docs/guides/api_tokens.md

@@ -2,7 +2,7 @@
 
 Access Tokens can be used to authenticate users for your own site, or when allowing third-party developers to access your API. When making requests using access tokens, the token should be included in the `Authorization` header as a `Bearer` token.
 
-> **Note**  By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change this value by setting the `$authenticatorHeader['tokens']` value in the `Auth.php` config file.
+> **Note**  By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change this value by setting the `$authenticatorHeader['tokens']` value in the **app/Config/Auth.php** config file.
 
 Tokens are issued with the `generateAccessToken()` method on the user. This returns a `CodeIgniter\Shield\Entities\AccessToken` instance. Tokens are hashed using a SHA-256 algorithm before being saved to the database. The access token returned when you generate it will include a `raw_token` field that contains the plain-text, un-hashed, token. You should display this to your user at once so they have a chance to copy it somewhere safe, as this is the only time this will be available. After this request, there is no way to get the raw token.
 
@@ -57,7 +57,7 @@ $user->revokeAllAccessTokens();
 
 The first way to specify which routes are protected is to use the `tokens` controller filter.
 
-For example, to ensure it protects all routes under the `/api` route group, you would use the `$filters` setting on `app/Config/Filters.php`.
+For example, to ensure it protects all routes under the `/api` route group, you would use the `$filters` setting on **app/Config/Filters.php**.
 
 ```php
 public $filters = [

docs/guides/mobile_apps.md

@@ -1,6 +1,6 @@
 # Mobile Authentication with Access Tokens
 
-Access Tokens can be used to authenticate mobile applications that are consuming your API. This is similar to how you would work with [third-party users](api_tokens.md) of your API, but with small differences in how you would issue the tokens.
+Access Tokens can be used to authenticate mobile applications that are consuming your API. This is similar to how you would work with [third-party users](./api_tokens.md) of your API, but with small differences in how you would issue the tokens.
 
 ## Issuing the Tokens
 
@@ -61,6 +61,6 @@ When making all future requests to the API, the mobile client should return the
 
 > **Note**
 >
-> By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change the header name by setting the `$authenticatorHeader['tokens']` value in the `Auth.php` config file.
+> By default, `$authenticatorHeader['tokens']` is set to `Authorization`. You can change the header name by setting the `$authenticatorHeader['tokens']` value in the **app/Config/Auth.php** config file.
 >
 > e.g. if `$authenticatorHeader['tokens']` is set to `PersonalAccessCodes` then the mobile client should return the raw token in the `PersonalAccessCodes` header as a `Bearer` token.

docs/install.md

@@ -12,7 +12,7 @@
     - [Protect All Pages](#protect-all-pages)
     - [Rate Limiting](#rate-limiting)
 
-These instructions assume that you have already [installed the CodeIgniter 4 app starter](https://codeigniter.com/user_guide/installation/installing_composer.html) as the basis for your new project, set up your `.env` file, and created a database that you can access via the Spark CLI script.
+These instructions assume that you have already [installed the CodeIgniter 4 app starter](https://codeigniter.com/user_guide/installation/installing_composer.html) as the basis for your new project, set up your **.env** file, and created a database that you can access via the Spark CLI script.
 
 ## Requirements
 
@@ -54,14 +54,14 @@ Require it with an explicit version constraint allowing its desired stability.
     ```
 
     The above specifies `develop` branch.
-    See https://getcomposer.org/doc/articles/versions.md#branches
+    See <https://getcomposer.org/doc/articles/versions.md#branches>
 
     ```console
     composer require codeigniter4/shield:^1.0.0-beta
     ```
 
     The above specifies `v1.0.0-beta` or later and before `v2.0.0`.
-    See https://getcomposer.org/doc/articles/versions.md#caret-version-range-
+    See <https://getcomposer.org/doc/articles/versions.md#caret-version-range->
 
 ## Initial Setup
 
@@ -73,7 +73,7 @@ Require it with an explicit version constraint allowing its desired stability.
     php spark shield:setup
     ```
 
-2. Configure `app/Config/Email.php` to allow Shield to send emails with the [Email Class](https://codeigniter.com/user_guide/libraries/email.html).
+2. Configure **app/Config/Email.php** to allow Shield to send emails with the [Email Class](https://codeigniter.com/user_guide/libraries/email.html).
 
     ```php
     <?php
@@ -103,7 +103,7 @@ Require it with an explicit version constraint allowing its desired stability.
 There are a few setup items to do before you can start using Shield in
 your project.
 
-1. Copy the `Auth.php` and  `AuthGroups.php` from `vendor/codeigniter4/shield/src/Config/` into your project's config folder and update the namespace to `Config`. You will also need to have these classes extend the original classes. See the example below. These files contain all of the settings, group, and permission information for your application and will need to be modified to meet the needs of your site.
+1. Copy the **Auth.php** and  **AuthGroups.php** from **vendor/codeigniter4/shield/src/Config/** into your project's config folder and update the namespace to `Config`. You will also need to have these classes extend the original classes. See the example below. These files contain all of the settings, group, and permission information for your application and will need to be modified to meet the needs of your site.
 
     ```php
     // new file - app/Config/Auth.php
@@ -120,7 +120,7 @@ your project.
     }
     ```
 
-2. **Helper Setup** The `setting` helper needs to be included in almost every page. The simplest way to do this is to add it to the `BaseController::initController` method:
+2. **Helper Setup** The `setting` helper needs to be included in almost every page. The simplest way to do this is to add it to the `BaseController::initController()` method:
 
     ```php
     public function initController(RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)
@@ -134,13 +134,13 @@ your project.
 
     This requires that all of your controllers extend the `BaseController`, but that's a good practice anyway.
 
-3. **Routes Setup** The default auth routes can be setup with a single call in `app/Config/Routes.php`:
+3. **Routes Setup** The default auth routes can be setup with a single call in **app/Config/Routes.php**:
 
     ```php
     service('auth')->routes($routes);
     ```
 
-4. **Security Setup** Set `Config\Security::$csrfProtection` to `'session'` (or set `security.csrfProtection = session` in your `.env` file) for security reasons, if you use Session Authenticator.
+4. **Security Setup** Set `Config\Security::$csrfProtection` to `'session'` (or set `security.csrfProtection = session` in your **.env** file) for security reasons, if you use Session Authenticator.
 
 5. **Migration** Run the migrations.
 
@@ -152,14 +152,14 @@ your project.
 
     When you run `spark migrate --all`, if you get `Class "SQLite3" not found` error:
 
-    1. Remove sample migration files in `tests/_support/Database/Migrations/`
+    1. Remove sample migration files in **tests/_support/Database/Migrations/**
     2. Or install `sqlite3` php extension
 
     If you get `Specified key was too long` error:
 
     1. Use InnoDB, not MyISAM.
 
-6. Configure `app/Config/Email.php` to allow Shield to send emails.
+6. Configure **app/Config/Email.php** to allow Shield to send emails.
 
     ```php
     <?php
@@ -207,13 +207,13 @@ auth-rates | Provides a good basis for rate limiting of auth-related routes.
 group | Checks if the user is in one of the groups passed in.
 permission | Checks if the user has the passed permissions.
 
-These can be used in any of the [normal filter config settings](https://codeigniter.com/user_guide/incoming/filters.html?highlight=filter#globals), or [within the routes file](https://codeigniter.com/user_guide/incoming/routing.html?highlight=routs#applying-filters).
+These can be used in any of the [normal filter config settings](https://codeigniter.com/user_guide/incoming/filters.html#globals), or [within the routes file](https://codeigniter.com/user_guide/incoming/routing.html#applying-filters).
 
-> **Note** These filters are already loaded for you by the registrar class located at `src/Config/Registrar.php`.
+> **Note** These filters are already loaded for you by the registrar class located at **src/Config/Registrar.php**.
 
 ### Protect All Pages
 
-If you want to limit all routes (e.g. `localhost:8080/admin`, `localhost:8080/panel` and ...), you need to add the following code in the `app/Config/Filters.php` file.
+If you want to limit all routes (e.g. `localhost:8080/admin`, `localhost:8080/panel` and ...), you need to add the following code in the **app/Config/Filters.php** file.
 
 ```php
 public $globals = [
@@ -241,7 +241,7 @@ public $filters = [
 ];
 ```
 
-> **Note** If you have grouped or changed the default format of the routes, ensure that your code matches the new format(s) in the `App/Config/Filter.php` file.
+> **Note** If you have grouped or changed the default format of the routes, ensure that your code matches the new format(s) in the **app/Config/Filter.php** file.
 
 For example, if you configured your routes like so:
 
@@ -260,4 +260,4 @@ public $globals = [
     ]
 ]
 ```
-The same should apply for the Rate Limiting.
+The same should apply for the Rate Limiting.