Merge pull request #43 from suraj-webkul/remove-unused-docs-part

VikassWebkul214254 · web-flow · commit ccbc69f3694c · 2025-05-07T10:39:19.000+05:30
remove redundant admin login instructions from API documentation
diff --git a/docs/.vuepress/version-configs/1.x.js b/docs/.vuepress/version-configs/1.x.js
@@ -81,7 +81,7 @@ module.exports = [
         path: setVersionPrefix('api'),
         collapsable: true,
         children: setVersionPrefix([
-            ['api/getting-started-with-the-api', 'Rest API'],
+            ['api/getting-started-with-the-api', 'Explore REST API'],
         ]),
     },
 ];
diff --git a/docs/.vuepress/version-configs/2.0.js b/docs/.vuepress/version-configs/2.0.js
@@ -92,7 +92,7 @@ module.exports = [
         path: setVersionPrefix('api'),
         collapsable: true,
         children: setVersionPrefix([
-            ['api/getting-started-with-the-api', 'Rest API'],
+            ['api/getting-started-with-the-api', 'Explore REST API'],
         ]),
     },
 ];
diff --git a/docs/.vuepress/version-configs/2.1.js b/docs/.vuepress/version-configs/2.1.js
@@ -94,7 +94,7 @@ module.exports = [
         path: setVersionPrefix('api'),
         collapsable: true,
         children: setVersionPrefix([
-            ['api/getting-started-with-the-api', 'Rest API'],
+            ['api/getting-started-with-the-api', 'Explore REST API'],
         ]),
     },
 ];
diff --git a/docs/.vuepress/version-configs/master.js b/docs/.vuepress/version-configs/master.js
@@ -94,7 +94,7 @@ module.exports = [
         path: setVersionPrefix('api'),
         collapsable: true,
         children: setVersionPrefix([
-            ['api/getting-started-with-the-api', 'Rest API'],
+            ['api/getting-started-with-the-api', 'Explore REST API'],
         ]),
     },
 ];
diff --git a/docs/1.x/advanced/events.md b/docs/1.x/advanced/events.md
@@ -1,5 +1,3 @@
-<!-- @format -->
-
 # Events
 
 [[TOC]]
diff --git a/docs/1.x/api/getting-started-with-the-api.md b/docs/1.x/api/getting-started-with-the-api.md
@@ -2,17 +2,17 @@
 
 [[toc]]
 
-## REST API
+### REST API
 
 Krayin REST API is a medium to use the features of the core Krayin System. By using Krayin REST API, you can integrate your application to serve the default content of Krayin.
 
-## Explore REST API Demo
+### Demo
 
 Welcome to our API demo! Dive into the interactive showcase of our API functionalities to get a hands-on experience of how our platform works. Click the Link below to access the demo:
 
 [Access API Demo](https://demo.krayincrm.com/krayin-rest-api/)
 
-#### Click the Link below to access Admin API documentation 
+#### Click the Link below to access Admin API documentation
 
 [Admin](https://demo.krayincrm.com/krayin-rest-api-24046b004402/api/documentation)
 
@@ -22,45 +22,26 @@ To install Krayin REST API, you need to follow some steps.
 
 - To install Krayin REST API from your console:
 
-~~~
+```
 composer require krayin/rest-api
-~~~
+```
 
 - Add below options in the .env file (i.e. http://localhost/public your domain):
 
-~~~
+```
 SANCTUM_STATEFUL_DOMAINS=http://localhost/public
-~~~
+```
 
 - To configure the REST API L5-Swagger Documentation run below command:
 
-~~~
+```
 php artisan krayin-rest-api:install
-~~~
+```
 
 - To check the Admin end API documentation:
 
-~~~
+```
 http://localhost/public/api/admin/documentation
-~~~
+```
 
-* You can check the <a href="https://github.com/DarkaOnLine/L5-Swagger"> L5-Swagger </a> guidelines too regarding the configuration the API documentation.
-
--  For admin login, add Laravel Sanctum's API token to the Admin model follow the given path.
-
-~~~
-packages/Webkul/User/src/Models/Admin.php
-~~~
-
-~~~php
-<?php
-namespace Webkul\User\Models;
-
-use Laravel\Sanctum\HasApiTokens;
-
-class Admin extends Authenticatable implements AdminContract
-{
-    use HasApiTokens;
-    ...
-}
-~~~
+- You can check the <a href="https://github.com/DarkaOnLine/L5-Swagger"> L5-Swagger </a> guidelines too regarding the configuration the API documentation.
diff --git a/docs/2.0/advanced/events.md b/docs/2.0/advanced/events.md
@@ -1,5 +1,3 @@
-<!-- @format -->
-
 # Events
 
 [[TOC]]
diff --git a/docs/2.0/api/getting-started-with-the-api.md b/docs/2.0/api/getting-started-with-the-api.md
@@ -2,11 +2,11 @@
 
 [[toc]]
 
-## REST API
+### REST API
 
 Krayin REST API is a medium to use the features of the core Krayin System. By using Krayin REST API, you can integrate your application to serve the default content of Krayin.
 
-## Explore REST API Demo
+### Demo
 
 Welcome to our API demo! Dive into the interactive showcase of our API functionalities to get a hands-on experience of how our platform works. Click the Link below to access the demo:
 
@@ -46,21 +46,3 @@ http://localhost/public/api/admin/documentation
 
 * You can check the <a href="https://github.com/DarkaOnLine/L5-Swagger"> L5-Swagger </a> guidelines too regarding the configuration the API documentation.
 
--  For admin login, add Laravel Sanctum's API token to the Admin model follow the given path.
-
-~~~
-packages/Webkul/User/src/Models/Admin.php
-~~~
-
-~~~php
-<?php
-namespace Webkul\User\Models;
-
-use Laravel\Sanctum\HasApiTokens;
-
-class Admin extends Authenticatable implements AdminContract
-{
-    use HasApiTokens;
-    ...
-}
-~~~
diff --git a/docs/2.1/advanced/ai-powered-lead-generation.md b/docs/2.1/advanced/ai-powered-lead-generation.md
@@ -1,5 +1,3 @@
-<!-- @format -->
-
 [[TOC]]
 
 # AI-Powered Lead Generation
diff --git a/docs/2.1/advanced/events.md b/docs/2.1/advanced/events.md
@@ -1,5 +1,3 @@
-<!-- @format -->
-
 # Events
 
 [[TOC]]
diff --git a/docs/2.1/advanced/override-a-layout.md b/docs/2.1/advanced/override-a-layout.md
@@ -1,5 +1,3 @@
-<!-- @format -->
-
 # Overview
 
 Krayin CRM enables seamless customization through overrides and events. You can override controllers, models, and views to modify core logic, database behavior, or UI. Additionally, view render events allow dynamic content injection into Blade templates, making extensions modular and non-intrusive.
diff --git a/docs/2.1/api/getting-started-with-the-api.md b/docs/2.1/api/getting-started-with-the-api.md
@@ -2,11 +2,11 @@
 
 [[toc]]
 
-## REST API
+### REST API
 
 Krayin REST API is a medium to use the features of the core Krayin System. By using Krayin REST API, you can integrate your application to serve the default content of Krayin.
 
-## Explore REST API Demo
+### Demo
 
 Welcome to our API demo! Dive into the interactive showcase of our API functionalities to get a hands-on experience of how our platform works. Click the Link below to access the demo:
 
@@ -45,22 +45,3 @@ http://localhost/public/api/admin/documentation
 ~~~
 
 * You can check the <a href="https://github.com/DarkaOnLine/L5-Swagger"> L5-Swagger </a> guidelines too regarding the configuration the API documentation.
-
--  For admin login, add Laravel Sanctum's API token to the Admin model follow the given path.
-
-~~~
-packages/Webkul/User/src/Models/Admin.php
-~~~
-
-~~~php
-<?php
-namespace Webkul\User\Models;
-
-use Laravel\Sanctum\HasApiTokens;
-
-class Admin extends Authenticatable implements AdminContract
-{
-    use HasApiTokens;
-    ...
-}
-~~~
diff --git a/docs/README.md b/docs/README.md
@@ -13,5 +13,3 @@ features:
     details: Learn how to connect your existing systems with the Krayin API.
 footer: © Copyright 2010-2025, Webkul Software (Registered in India/USA). All rights reserved.
 ---
-
-<!-- @format -->
diff --git a/docs/master/advanced/ai-powered-lead-generation.md b/docs/master/advanced/ai-powered-lead-generation.md
@@ -1,5 +1,3 @@
-<!-- @format -->
-
 [[TOC]]
 
 # AI-Powered Lead Generation
diff --git a/docs/master/advanced/events.md b/docs/master/advanced/events.md
@@ -1,5 +1,3 @@
-<!-- @format -->
-
 # Events
 
 [[TOC]]
diff --git a/docs/master/api/getting-started-with-the-api.md b/docs/master/api/getting-started-with-the-api.md
@@ -2,11 +2,11 @@
 
 [[toc]]
 
-## REST API
+### REST API
 
 Krayin REST API is a medium to use the features of the core Krayin System. By using Krayin REST API, you can integrate your application to serve the default content of Krayin.
 
-## Explore REST API Demo
+### Demo
 
 Welcome to our API demo! Dive into the interactive showcase of our API functionalities to get a hands-on experience of how our platform works. Click the Link below to access the demo:
 
@@ -45,22 +45,3 @@ http://localhost/public/api/admin/documentation
 ~~~
 
 * You can check the <a href="https://github.com/DarkaOnLine/L5-Swagger"> L5-Swagger </a> guidelines too regarding the configuration the API documentation.
-
--  For admin login, add Laravel Sanctum's API token to the Admin model follow the given path.
-
-~~~
-packages/Webkul/User/src/Models/Admin.php
-~~~
-
-~~~php
-<?php
-namespace Webkul\User\Models;
-
-use Laravel\Sanctum\HasApiTokens;
-
-class Admin extends Authenticatable implements AdminContract
-{
-    use HasApiTokens;
-    ...
-}
-~~~

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-<!-- @format -->`
`2`		`-`
`3`	`1`	`# Events`
`4`	`2`
`5`	`3`	`[[TOC]]`