You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: improve installation page clarity and consistency
- Fix broken link to license page (remove non-existent anchor)
- Simplify AGPL warning to concise blockquote
- Use consistent step format (### N. Title pattern)
- Extract shared CSS step outside tabs to avoid duplication
- Streamline step numbering (4 for commercial, 2 for open source)
Copy file name to clipboardExpand all lines: docs/content/1.getting-started/1.installation.md
+19-40Lines changed: 19 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,13 +24,11 @@ Choose your installation method based on your license type:
24
24
25
25
::tabs
26
26
::tab{label="Commercial License"}
27
-
### For commercial/private projects
27
+
### 1. Purchase a License
28
28
29
-
**Step 1: Purchase a license**
29
+
[Choose a commercial license](/community/license) that fits your project.
30
30
31
-
[Choose a commercial license](/community/license#commercial-license-pricing)
32
-
33
-
**Step 2: Add the private repository**
31
+
### 2. Add Private Repository
34
32
35
33
Add our private Composer repository to your `composer.json`:
36
34
@@ -45,7 +43,7 @@ Choose your installation method based on your license type:
45
43
}
46
44
```
47
45
48
-
**Step 3: Install the package**
46
+
### 3. Install Package
49
47
50
48
```bash
51
49
composer require relaticle/custom-fields:^3.0
@@ -55,64 +53,45 @@ Choose your installation method based on your license type:
55
53
-**Username**: Your email (used for purchase)
56
54
-**Password**: Your license key
57
55
58
-
**Step 4: Run the installer**
56
+
Your license key will be saved in Composer's auth file for future updates.
57
+
58
+
### 4. Run Installer
59
59
60
60
```bash
61
61
php artisan custom-fields:install
62
62
```
63
-
64
-
**Step 5: Include CSS assets**
65
-
66
-
You need a custom Filament theme to include the Custom Fields styles. If you haven't set up a custom theme for Filament, follow the [Filament Docs](https://filamentphp.com/docs/5.x/panels/themes#creating-a-custom-theme) first.
67
-
68
-
Once you have a custom Filament theme set up, add the plugin's views to your theme CSS file:
Your license key will be saved in Composer's auth file for future updates.
77
63
::
78
64
79
65
::tab{label="Open Source (AGPL-3.0)"}
80
-
**AGPL-3.0 License Requirements**: This installation method requires your **entire application** to be open source and licensed under AGPL-3.0. This applies to ALL code in your project, including:
81
-
- Your application code
82
-
- SaaS/web applications accessible over a network
83
-
- Any modifications or extensions
84
-
85
-
If you cannot make your entire codebase public, you **must** use a [Commercial License](/community/license#commercial-license-pricing) instead.
86
-
87
-
### For open source projects
66
+
> **AGPL-3.0 License**: Requires your **entire application** to be open source. See [license details](/community/license).
88
67
89
-
**Step 1: Install the package**
68
+
### 1. Install Package
90
69
91
70
Install directly from Packagist:
92
71
93
72
```bash
94
73
composer require relaticle/custom-fields:^3.0
95
74
```
96
75
97
-
**Step 2: Run the installer**
76
+
### 2. Run Installer
98
77
99
78
```bash
100
79
php artisan custom-fields:install
101
80
```
81
+
::
82
+
::
102
83
103
-
**Step 3: Include CSS assets**
84
+
## Include CSS Assets
104
85
105
-
You need a custom Filament theme to include the Custom Fields styles. If you haven't set up a custom theme for Filament, follow the [Filament Docs](https://filamentphp.com/docs/5.x/panels/themes#creating-a-custom-theme) first.
86
+
You need a custom Filament theme to include the Custom Fields styles. If you haven't set up a custom theme for Filament, follow the [Filament Docs](https://filamentphp.com/docs/5.x/panels/themes#creating-a-custom-theme) first.
106
87
107
-
Once you have a custom Filament theme set up, add the plugin's views to your theme CSS file:
88
+
Once you have a custom Filament theme set up, add the plugin's views to your theme CSS file:
0 commit comments