Added docs index file and removed file numbers, and added TOC to each file.

Author: lonnieezell

docs/_index.md

@@ -0,0 +1,11 @@
+# Shield Documentation
+
+* [Installation Guide](install.md)
+* [Concepts You Need To Know](concepts.md)
+* [Quick Start Guide](quickstart.md)
+* [Authentication](authentication.md)
+* [Authorization](authorization.md)
+* [Auth Actions](auth_actions.md)
+* [Events](events.md)
+* [Testing](testing.md)
+* [Customization](customization.md)

docs/4 - auth_actions.md docs/auth_actions.mddocs/4 - auth_actions.md renamed to docs/auth_actions.md

@@ -1,5 +1,9 @@
 # Authentication Actions
 
+- [Authentication Actions](#authentication-actions)
+  - [Configuring Actions](#configuring-actions)
+  - [Defining New Actions](#defining-new-actions)
+
 Authentication Actions are a way to group actions that can happen after login or registration.
 Shield ships with two actions you can use, and makes it simple for you to define your own.
 

docs/3 - authentication.md docs/authentication.mddocs/3 - authentication.md renamed to docs/authentication.md

@@ -1,5 +1,26 @@
 # Authentication
 
+- [Authentication](#authentication)
+  - [Available Authenticators](#available-authenticators)
+  - [Auth Helper](#auth-helper)
+  - [Authenticator Responses](#authenticator-responses)
+    - [isOK()](#isok)
+    - [reason()](#reason)
+    - [extraInfo()](#extrainfo)
+  - [Session Authenticator](#session-authenticator)
+    - [attempt()](#attempt)
+    - [check()](#check)
+    - [loggedIn()](#loggedin)
+    - [logout()](#logout)
+    - [forget()](#forget)
+  - [Access Token Authenticator](#access-token-authenticator)
+    - [Access Token/API Authentication](#access-tokenapi-authentication)
+    - [Generating Access Tokens](#generating-access-tokens)
+    - [Revoking Access Tokens](#revoking-access-tokens)
+    - [Retrieving Access Tokens](#retrieving-access-tokens)
+    - [Access Token Lifetime](#access-token-lifetime)
+    - [Access Token Scopes](#access-token-scopes)
+
 Authentication is the process of determining that a visitor actually belongs to your website,
 and identifying them. Shield provides a flexible and secure authentication system for your
 web apps and APIs.

docs/5 - authorization.md docs/authorization.mddocs/5 - authorization.md renamed to docs/authorization.md

@@ -1,5 +1,22 @@
 # Authorization
 
+- [Authorization](#authorization)
+  - [Defining Available Groups](#defining-available-groups)
+    - [Default User Group](#default-user-group)
+  - [Defining Available Permissions](#defining-available-permissions)
+  - [Assigning Permissions to Groups](#assigning-permissions-to-groups)
+  - [Authorizing Users](#authorizing-users)
+      - [can()](#can)
+      - [inGroup()](#ingroup)
+  - [Managing User Permissions](#managing-user-permissions)
+      - [addPermission()](#addpermission)
+      - [removePermission()](#removepermission)
+      - [syncPermissions()](#syncpermissions)
+  - [Managing User Groups](#managing-user-groups)
+      - [addGroup()](#addgroup)
+      - [removeGroup()](#removegroup)
+      - [syncGroups()](#syncgroups)
+
 Authorization happens once a user has been identified through authentication. It is the process of
 determining what actions a user is allowed to do within your site.
 

docs/1 - concepts.md docs/concepts.mddocs/1 - concepts.md renamed to docs/concepts.md

@@ -2,6 +2,13 @@
 
 This document covers some of the base concepts used throughout the library.
 
+- [Shield Concepts](#shield-concepts)
+  - [Repository State](#repository-state)
+  - [Settings](#settings)
+  - [User Providers](#user-providers)
+  - [User Identities](#user-identities)
+  - [Password Validators](#password-validators)
+
 ## Repository State
 
 Shield is designed so that the initial setup of your application can all happen in code with nothing required to be

docs/8 - customization.md docs/customization.mddocs/8 - customization.md renamed to docs/customization.md

@@ -1,5 +1,10 @@
 # Customizing Shield
 
+- [Customizing Shield](#customizing-shield)
+  - [Route Configuration](#route-configuration)
+  - [Custom Redirect URLs](#custom-redirect-urls)
+  - [Extending the Controllers](#extending-the-controllers)
+
 ## Route Configuration
 
 If you need to customize how any of the auth features are handled, you will likely need to update the routes to point to the correct controllers. You can still use the `service('auth')->routes()` helper, but you will need to pass the `except` option with a list of routes to customize:

docs/6 - events.md docs/events.mddocs/6 - events.md renamed to docs/events.md

@@ -2,6 +2,14 @@
 
 Shield fires off several events during the lifecycle of the application that your code can tap into.
 
+- [Events](#events)
+  - [Responding to Events](#responding-to-events)
+    - [Event List](#event-list)
+      - [register](#register)
+      - [login](#login)
+      - [failedLogin](#failedlogin)
+      - [logout](#logout)
+
 ## 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`

docs/0 - install.md docs/install.mddocs/0 - install.md renamed to docs/install.md

@@ -1,5 +1,14 @@
 # Installation
 
+- [Installation](#installation)
+      - [IMPORTANT: composer error](#important-composer-error)
+      - [Note: migration error](#note-migration-error)
+  - [Initial Setup](#initial-setup)
+    - [Command Setup](#command-setup)
+    - [Manual Setup](#manual-setup)
+  - [Controller Filters](#controller-filters)
+    - [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.
 
 Installation is done through [Composer](https://getcomposer.org). The example assumes you have it installed globally.

docs/2 - quickstart.md docs/quickstart.mddocs/2 - quickstart.md renamed to docs/quickstart.md

@@ -4,6 +4,27 @@ Learning any new authentication system can be difficult, especially as they get
 
 NOTE: The examples assume that you have run the setup script and that you have copies of the `Auth` and `AuthGroups` config files in your application's `app/Config` folder.
 
+- [Quick Start Guide](#quick-start-guide)
+  - [Authentication Flow](#authentication-flow)
+    - [Customize login redirect](#customize-login-redirect)
+    - [Customize register redirect](#customize-register-redirect)
+    - [Customize logout redirect](#customize-logout-redirect)
+    - [Customize Remember-me functionality](#customize-remember-me-functionality)
+    - [Change Access Token Lifetime](#change-access-token-lifetime)
+    - [Enable Two-Factor Authentication](#enable-two-factor-authentication)
+    - [Enable Account Activation via Email](#enable-account-activation-via-email)
+  - [Authorization Flow](#authorization-flow)
+    - [Change Available Groups](#change-available-groups)
+    - [Set the Default Group](#set-the-default-group)
+    - [Change Available Permissions](#change-available-permissions)
+    - [Assign Permissions to a Group](#assign-permissions-to-a-group)
+    - [Assign Permissions to a User](#assign-permissions-to-a-user)
+  - [Check If a User Has Permission](#check-if-a-user-has-permission)
+  - [Managing Users](#managing-users)
+    - [Creating Users](#creating-users)
+    - [Deleting Users](#deleting-users)
+    - [Editing A User](#editing-a-user)
+
 ## Authentication Flow
 
 If you need everyone to redirect to a single URL after login/logout/register actions, you can modify the `Config\Auth::redirects` array to specify the url to redirect to.