Merge pull request #610 from wayofdev/feat/docs

Author: lotyp

Makefile

@@ -29,6 +29,8 @@ EXPORT_VARS = '\
 	$${COMPOSE_PROJECT_NAME} \
 	$${COMPOSER_AUTH}'
 
+NPM_RUNNER ?= pnpm
+
 
 # Self documenting Makefile code
 # ------------------------------------------------------------------------------------
@@ -182,3 +184,9 @@ test: ## Run project php-unit and pest tests
 test-cc: ## Run project php-unit and pest tests in coverage mode and build report
 	$(APP_COMPOSER) test:cc
 .PHONY: test-cc
+
+# Documentation
+# ------------------------------------------------------------------------------------
+docs-deps-update: ## Check for outdated dependencies and automatically update them using pnpm
+	cd docs && $(NPM_RUNNER) run deps:update
+.PHONY: docs-deps-update

README.md

@@ -49,6 +49,16 @@ The full documentation for the package is available at [https://laravel-cycle-or
 
 <br>
 
+
+## 🧩 Compatibility Map
+
+| Laravel | Cycle ORM Adapter | Cycle ORM |
+|---------|-------------------|-----------|
+| 10.x    | 4.x               | 2.x       |
+| 11.x    | 5.x (Planned)     | 2.x       |
+
+<br>
+
 ## 🤝 Contributing
 
 Contributions are welcome!

docs/.ncurc.yml

@@ -0,0 +1,7 @@
+---
+# npm-check-updates configuration used by yarn deps:check && yarn deps:update
+# convenience scripts.
+# @link https://github.com/raineorshine/npm-check-updates
+
+# Add here exclusions on packages if any
+reject: []

docs/package.json

@@ -5,7 +5,8 @@
   "scripts": {
     "dev": "next dev",
     "build": "next build",
-    "start": "next start"
+    "start": "next start",
+    "deps:update": "pnpm dlx npm-check-updates --configFileName .ncurc.yml -u --deep --mergeConfig && pnpm install"
   },
   "repository": {
     "type": "git",
@@ -18,7 +19,8 @@
   },
   "homepage": "https://github.com/shuding/nextra-docs-template#readme",
   "dependencies": {
-    "next": "^14.0.0",
+    "@vercel/analytics": "^1.2.2",
+    "next": "^14.1.3",
     "nextra": "latest",
     "nextra-theme-docs": "latest",
     "react": "^18.2.0",
@@ -29,6 +31,6 @@
     "autoprefixer": "^10.4.18",
     "postcss": "^8.4.35",
     "tailwindcss": "^3.4.1",
-    "typescript": "^5.0.0"
+    "typescript": "^5.4.2"
   }
 }

docs/pages/_app.tsx

@@ -0,0 +1,16 @@
+import { Analytics } from '@vercel/analytics/react'
+import type { AppProps } from 'next/app'
+import type { ReactElement } from 'react'
+
+import '../style.css'
+
+function Nextra({ Component, pageProps }: AppProps): ReactElement {
+    return (
+        <>
+            <Component {...pageProps} />
+            <Analytics />
+        </>
+    )
+}
+
+export default Nextra

docs/pages/contributing.mdx

@@ -49,6 +49,32 @@ This leads to more readable messages that are easy to follow when looking throug
 - **chore** — Other changes that don't modify src or test files
 - **security** — A code change that fixes a security issue
 
+## 🧪 Running Tests
+
+### → PHPUnit Tests
+
+To run phpunit (pest) tests, run the following command:
+
+```bash
+$ make test
+```
+
+### → Static Analysis
+
+Run Code quality checks using [PHPStan](https://phpstan.org):
+
+```bash
+$ make lint-stan
+```
+
+### → Coding Standards Fixing
+
+Fix code using [The PHP Coding Standards Fixer](https://github.com/wayofdev/php-cs-fixer-config) to follow our standards:
+
+```bash
+$ make lint-php
+```
+
 ## 🔓 Security Vulnerabilities
 
 If you discover a security vulnerability within this package, please send an e-mail to WayOfDev via the@wayof.dev. All security vulnerabilities will be promptly addressed.

docs/pages/installation.mdx

@@ -9,11 +9,21 @@ Before you begin, ensure your development environment meets the following requir
 - **PHP Version:** 8.2 or higher
 - **Laravel:** 10.x or higher
 
+## 🧩 Compatibility Map
+
+| Laravel | Cycle ORM Adapter | Cycle ORM |
+|---------|-------------------|-----------|
+| 10.x    | 4.x               | 2.x       |
+| 11.x    | 5.x (Planned)     | 2.x       |
+
+
 ## 🚀 Quick Start
 
 Installing the Laravel Cycle ORM Adapter is straightforward with Composer. Follow the steps below to add the adapter to your Laravel project.
 
-### Step 1: Install the Adapter
+<div className="steps-container">
+
+### Step: Install the Adapter
 
 For the core functionality, run the following Composer command in your terminal:
 
@@ -23,7 +33,7 @@ $ composer req wayofdev/laravel-cycle-orm-adapter
 
 This command installs the wayofdev/laravel-cycle-orm-adapter package, integrating Cycle ORM into your Laravel application.
 
-### Step 2: Publish Configuration
+### Step: Publish Configuration
 
 After installing the package, publish the configuration file using the `vendor:publish` command:
 
@@ -32,6 +42,8 @@ $ php artisan vendor:publish \
   --provider="WayOfDev\Cycle\Bridge\Laravel\Providers\CycleServiceProvider"
 ```
 
+</div>
+
 ## 🏭 Database Factories (Optional)
 
 If you need support for [Eloquent-like Factories](https://laravel.com/docs/10.x/eloquent-factories), install the following package: