Add mkdocs and change menu names to avoid margin collisions (#468)

CHANGELOG.md

@@ -5,7 +5,7 @@
 **WARNING**: this release (long time due) makes a step forward in PHP
 compatibility, leaving behind obsolete versions. While yii2-usuario should
 still work without issues on 5.6, from now on testing and development will
-look forward and manitain only >=7.4 versions.
+look forward and maintain only >=7.4 versions.
 
 There's a change in flash messages handling, please see #391
 
@@ -29,6 +29,7 @@ There's a change in flash messages handling, please see #391
 - Update PHP-CS-Fixer configuration to new version (maxxer)
 - Fix #391: Always create flash messages, allow `enableFlashMessages` only to dictate display (ajmedway)
 - Ehn #458: Multiple 2FA channels (email, sms) (acordeddu)
+- Fix #432: Fix documentation overlap by shortening page names (cgsmith)
 
 ## 1.5.1 April 5, 2020
 

docs/customizing/how-to-enhance-a-user-model.md

@@ -8,8 +8,8 @@ provide sensible defaults where it's possible, we encourage and keep in mind use
 Very often you have to override and add your own domain (or application specific code) to your user model. With this
 extension this is very easy and can be done in a few minutes!
 
-For the case if you're using [Sidekit Application Template](../installation/sidekit-application-template.md) or
+For the case if you're using [Sidekit Application Template](../install/sidekit-application-template.md) or
-[Advanced Application Template](../installation/advanced-application-template.md) create the following class file
+[Advanced Application Template](../install/advanced-application-template.md) create the following class file
 at the `%PROJECT_DIR%/common/models/User.php` path:
 
 ```php

docs/events/social-network-auth-events.md

@@ -42,7 +42,7 @@ Event::on(
 ```
 
 > For further information about how to authenticate via social networks and the available clients, please visit the 
-> [guide](../helpful-guides/social-network-authentication.md)
+> [guide](../guides/social-network-authentication.md)
 
 
 © [2amigos](http://www.2amigos.us/) 2013-2019

docs/guides/first-steps.md

@@ -13,7 +13,7 @@ After installing the extension and having configured everything, you need setup
 There are several ways to do that:
 
 * using migrations
-* using the Command line [Console Commands](../installation/console-commands.md)
+* using the Command line [Console Commands](../install/console-commands.md)
 
 ### Creating the first Administrator during a migration
 

docs/guides/how-to-switch-identities.md

@@ -55,7 +55,7 @@ if(Yii::$app->session->has($module->switchIdentitySessionKey)) {
 ``` 
 
 
-Check the [switchIdentitySessionKey](../installation/configuration-options.md#switchidentitysessionkey) documentation  
+Check the [switchIdentitySessionKey](../install/configuration-options.md#switchidentitysessionkey) documentation  
 for further information regarding this configuration option. 
 
 © [2amigos](http://www.2amigos.us/) 2013-2019

docs/index.md

@@ -135,29 +135,29 @@ This will ensure the proper functionality of login/guest user detection etc.
 Configuration may differ from template to template, the following are some guidelines for sidekit app template and 
 the official Yii2 advanced application template: 
 
-- [2amigos Application Template](installation/yii2-application-template.md)
+- [2amigos Application Template](install/yii2-application-template.md)
-- [Advanced Application Template](installation/advanced-application-template.md)
+- [Advanced Application Template](install/advanced-application-template.md)
 
 See also all the possible configuration options available: 
 
-- [Configuration Options](installation/configuration-options.md)
+- [Configuration Options](install/configuration-options.md)
-- [RBAC](installation/rbac.md)
+- [RBAC](install/rbac.md)
-- [Console Commands](installation/console-commands.md)
+- [Console Commands](install/console-commands.md)
-- [Mailer](installation/mailer.md)
+- [Mailer](install/mailer.md)
-- [Available Actions](installation/available-actions.md)
+- [Available Actions](install/available-actions.md)
-- [Migration guide from Dektrium tools](installation/migration-guide-from-dektrium-tools.md)
+- [Migration guide from Dektrium tools](install/migration-guide-from-dektrium-tools.md)
 
 #### Step 4 - First steps to use Yii2-usuario
 
-Proceed with [First steps to use Yii2-usuario](helpful-guides/first-steps.md)
+Proceed with [First steps to use Yii2-usuario](guides/first-steps.md)
 
 
 Enhancing and Overriding
 ------------------------
 
-- [How to Enhance a User Model](enhancing-and-overriding/how-to-enhance-a-user-model.md)
+- [How to Enhance a User Model](customizing/how-to-enhance-a-user-model.md)
-- [Overriding Classes](enhancing-and-overriding/overriding-classes.md) 
+- [Overriding Classes](customizing/overriding-classes.md) 
-- [Overriding Views](enhancing-and-overriding/overriding-views.md)
+- [Overriding Views](customizing/overriding-views.md)
 
 Events
 ------
@@ -182,13 +182,13 @@ there all your events and then include that file on your
 Helpful Guides
 --------------
 
-- [How to Add Captcha Widget](helpful-guides/how-to-add-captcha-widget.md)
+- [How to Add Captcha Widget](guides/how-to-add-captcha-widget.md)
-- [How to Add Google reCaptcha Widget](helpful-guides/how-to-use-recaptcha-widget.md)
+- [How to Add Google reCaptcha Widget](guides/how-to-use-recaptcha-widget.md)
-- [How to Implement Two-Factor Authentication](helpful-guides/how-to-implement-two-factor-auth.md)
+- [How to Implement Two-Factor Authentication](guides/how-to-implement-two-factor-auth.md)
-- [How to Switch Identities](helpful-guides/how-to-switch-identities.md)
+- [How to Switch Identities](guides/how-to-switch-identities.md)
-- [Separate Frontend and Backend Sessions](helpful-guides/separate-frontend-and-backend-sessions.md)
+- [Separate Frontend and Backend Sessions](guides/separate-frontend-and-backend-sessions.md)
-- [Social Network Authentication](helpful-guides/social-network-authentication.md)
+- [Social Network Authentication](guides/social-network-authentication.md)
-- [How to Enable session history](helpful-guides/how-to-use-session-history.md)
+- [How to Enable session history](guides/how-to-use-session-history.md)
 
 Contributing
 ------------

docs/install/configuration-options.md

@@ -5,7 +5,7 @@ The module comes with a set of attributes to configure. The following is the lis
 
 #### enableSessionHistory (Type: `boolean, integer`, Default value: `false`)
 
-If this option is to `true`, session history will be kept, [more](../helpful-guides/how-to-use-session-history.md).
+If this option is to `true`, session history will be kept, [more](../guides/how-to-use-session-history.md).
 
 #### numberSessionHistory (Type: `boolean, integer`, Default value: `false`)
 
@@ -255,7 +255,7 @@ Allows customization of the web application controller namespace for the module.
 #### classMap (type: `array`, default: `[]`)
 
 Configures the definitions of the classes as they have to be override. For more information see 
-[Overriding Classes](../enhancing-and-overriding/overriding-classes.md). 
+[Overriding Classes](../customizing/overriding-classes.md). 
 
 #### routes (type: `array`, default: `[]` )
 
@@ -275,7 +275,7 @@ The routes (url rules) of the module for the URL management. The default values
 
 #### viewPath (type: `string`, default: `@Da/User/resources/views`)
 
-Configures the root directory of the view files. See [overriding views](../enhancing-and-overriding/overriding-views.md).
+Configures the root directory of the view files. See [overriding views](../customizing/overriding-views.md).
 
 #### switchIdentitySessionKey (type: `string`, default: `yuik_usuario`) 
 

mkdocs.yml

@@ -0,0 +1 @@
+site_name: yii2-usuario