Profile docs

Author: binaryk

docs/.vuepress/3.0.js

@@ -30,9 +30,12 @@ module.exports = [
         children: ['rest-methods/rest-methods'],
     },
     {
-        title: 'Auth service',
+        title: 'Auth',
         collapsable: true,
-        children: ['auth/auth'],
+        children: [
+            'auth/auth',
+            'auth/profile'
+        ],
     },
     {
         title: 'Error handler',

docs/docs/3.0/auth/auth.md

@@ -1,18 +1,18 @@
 # Authentication setup
 
-Laravel Restify has support for authentication with Passport or Laravel Airlock.
+Laravel Restify has support for authentication with Passport or Laravel Sanctum.
 
 You'll finally enjoy the auth setup (`register`, `login`, `forgot` and `reset password`).
 
 :::tip
 
-Firstly make sure you have setup the desired provider in the `restify.auth.provider`.
-and make sure you have installed and configured the Laravel Passport (or Restify) properly. 
+Firstly make sure you have the setup the desired provider in the `restify.auth.provider`. Make sure you have installed and configured the [Laravel Sanctum](https://laravel.com/docs/7.x/sanctum#introduction) (or Passport) properly. 
+
 The passport check could be done easily by using the follow Restify command: 
 
 `php artisan restify:check-passport`
 
-This command will become with suggestions if anything is setup wrong.
+This command will become with suggestions if any setup is invalid.
 :::
 
 ## Prerequisites

docs/docs/3.0/auth/profile.md

@@ -0,0 +1,72 @@
+# User Profile
+
+[[toc]]
+
+Laravel Restify expose the user profile via `GET: /restify-api/profile` endpoint.
+
+## Get profile
+
+Get profile:
+
+// GET
+
+```http request
+/restify-api/profile
+```
+
+### Additional information
+
+However, the default user information could be enough in many cases, you are still free to add your own information on the user profile. 
+
+```php
+// User.php
+
+public function profile()
+{
+    return [
+        'roles' => [
+            'admin',
+        ],
+    ];
+}
+```
+
+## Update Profile
+
+Restify will update only `fillable` user attributes present in the request payload: `$request->only($user->getFillable())`.
+
+// PUT
+
+```http request
+/restify-api/profile
+```
+
+
+## User avatar
+
+If your user has an avatar, you can use the Restify endpoints to update the avatar: 
+
+// POST
+
+```http request
+restify-api/profile/avatar
+```
+
+The payload could be a form data, with an image under `avatar` key.
+
+The default path for storing avatar is: `/avatars/{user_key}/`.
+
+You can modify that by modifying property in a `boot` method of any service provider:
+
+```php
+Binaryk\LaravelRestify\Http\Requests\ProfileAvatarRequest::$path
+```
+
+Or if you need the request to make the path: 
+
+```php
+Binaryk\LaravelRestify\Http\Requests\ProfileAvatarRequest::usingPath(function(Illuminate\Http\Request $request) {
+    return 'avatars/' . $request->user()->uuid
+})
+```
+