- Added docs on installing scribe

Author: dash8x

docs/about-us.md

@@ -1,6 +1,6 @@
 ---
 title: About Us
-sidebar_position: 1.7
+sidebar_position: 1.10
 ---
 
 [Javaabu](https://javaabu.com) is a web design agency based in the Maldives.

docs/advanced-usage/_category_.json

@@ -1,5 +1,5 @@
 {
-    "position": 1.5,
+    "position": 1.7,
     "label": "Advanced Usage",
     "collapsible": true,
     "collapsed": false,

docs/changelog.md

@@ -1,6 +1,6 @@
 ---
 title: Changelog
-sidebar_position: 1.6
+sidebar_position: 1.9
 ---
 
 All notable changes to this package are documented on [GitHub](https://github.com/Javaabu/query-builder/blob/main/CHANGELOG.md)

docs/generating-api-docs/_category_.json

@@ -0,0 +1,11 @@
+{
+    "position": 1.6,
+    "label": "Generating API Docs",
+    "collapsible": true,
+    "collapsed": false,
+    "link": {
+        "type": "generated-index",
+        "slug": "/query-builder/_categories/generating-api-docs",
+        "description": "How to automatically generate API docs"
+    }
+}

docs/generating-api-docs/customizing-api-docs-metadata.md

@@ -0,0 +1,47 @@
+---
+title: Customizing API Docs Metadata
+sidebar_position: 2
+---
+
+This package will try to automatically generate documentation for the sorts, fields, appends, includes, and filters you have defined for your API controllers.
+The package uses the class name to determine the resource name and the resource group. You can see the relevant methods in `Javaabu\QueryBuilder\Concerns\ApiDocHelpers` trait.
+
+While the automatically generated documentation might be sufficient for most use cases, we recommend you to override some of the methods to provide more contextual documentation to developers.
+
+Here are some of the methods we recommend to override.
+
+## apiDocFilterMetadata()
+
+Use this method to describe what each filter does. Will support all properties allowed by `Knuckles\Scribe\Attributes\QueryParam` Attribute.
+
+```php
+// in ProductsController.php
+public static function apiDocFilterMetadata(): array
+{
+    return [
+        'id' => [
+            'type' => 'integer',
+        ],
+
+        'search' => [
+            'type' => 'string',
+            'description' => 'Search products by name.',
+        ]
+    ];
+}
+```
+
+
+## apiDocGroupDescription()
+
+Use this method to describe what your resource is.
+
+```php
+// in ProductsController.php
+public static function apiDocGroupDescription(): string
+{
+    return 'Endpoints for listing and viewing products'.;
+}
+```
+
+Apart from these methods, you can still use Sribe docblocks, Attributes and `inheritedDocsOverrides` to fully customize the documentation.

docs/generating-api-docs/setting-up-scribe.md

@@ -0,0 +1,95 @@
+---
+title: Setting up Scribe
+sidebar_position: 1
+---
+
+This package supports automatically generating API docs using [Scribe](https://github.com/knuckleswtf/scribe/).
+Before you can generate API docs, you need to first properly setup Scribe.
+
+## Install Scribe
+
+To get started, first install Scribe.
+
+```bash
+composer require knuckleswtf/scribe
+```
+
+## Publish Scribe Config
+
+Then publish the Scribe config.
+
+```bash
+php artisan vendor:publish --tag=scribe-config
+```
+
+## Add custom Sribe Strategies
+
+Now add the following Strategies provided by this package to the `scribe.php` config file.
+
+```php
+// in scribe.php config file
+'strategies' => [
+    'metadata' => [
+        ...Defaults::METADATA_STRATEGIES,
+        \Javaabu\QueryBuilder\Scribe\Strategies\MetadataStrategy::class, // add this to metadata strategies
+    ],
+    
+    ..
+    
+    'queryParameters' => [
+        ...Defaults::QUERY_PARAMETERS_STRATEGIES,
+        \Javaabu\QueryBuilder\Scribe\Strategies\QueryParametersStrategy::class, // add this to query parameter strategies
+    ],
+],
+```
+
+## Configure Auth
+
+You would most probably need to configure auth for Scribe. Add the following recommended auth config to `scribe.php` config file.
+
+```php
+// How is your API authenticated? This information will be used in the displayed docs, generated examples and response calls.
+'auth' => [
+    // Set this to true if ANY endpoints in your API use authentication.
+    'enabled' => true,
+
+    // Set this to true if your API should be authenticated by default. If so, you must also set `enabled` (above) to true.
+    // You can then use @unauthenticated or @authenticated on individual endpoints to change their status from the default.
+    'default' => true,
+
+    // Where is the auth value meant to be sent in a request?
+    'in' => AuthIn::BEARER->value,
+
+    // The name of the auth parameter (e.g. token, key, apiKey) or header (e.g. Authorization, Api-Key).
+    'name' => 'Authorization',
+
+    // Generate an access token / API key and add to the .env file
+    'use_value' => env('SCRIBE_AUTH_KEY'),
+
+    // Placeholder your users will see for the auth parameter in the example requests.
+    // Set this to null if you want Scribe to use a random value as placeholder instead.
+    'placeholder' => '{OAUTH_ACCESS_TOKEN}',
+
+    // Add instructions on how to get the access token
+    'extra_info' => 'You can retrieve your access token by visiting your profile in the dashboard and clicking <b>New API Token</b>. '.
+        'Only users that have the "Generate Personal Access Token" permission will be able to generate new access tokens.',
+],
+```
+
+Then add the access token to the `.env` file for Scribe to use.
+
+```dotenv
+SCRIBE_AUTH_KEY=your-access-token
+```
+
+## Generate API Docs
+
+That's it! Now when you just need to run.
+
+```bash
+php artisan scribe:generate
+```
+
+And your API docs will be magically created with sensible documentation.
+
+

docs/questions-and-security.md

@@ -1,6 +1,6 @@
 ---
 title: Questions and Security
-sidebar_position: 1.5
+sidebar_position: 1.8
 ---
 
 Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving this package? Feel free to create an [issue](../../issues) on GitHub, we'll try to address it as soon as possible.