Skip to content

Commit c1fe796

Browse files
committed
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)
1 parent 16fb9fa commit c1fe796

File tree

1 file changed

+19
-40
lines changed

1 file changed

+19
-40
lines changed

docs/content/1.getting-started/1.installation.md

Lines changed: 19 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,11 @@ Choose your installation method based on your license type:
2424

2525
::tabs
2626
::tab{label="Commercial License"}
27-
### For commercial/private projects
27+
### 1. Purchase a License
2828

29-
**Step 1: Purchase a license**
29+
[Choose a commercial license](/community/license) that fits your project.
3030

31-
[Choose a commercial license](/community/license#commercial-license-pricing)
32-
33-
**Step 2: Add the private repository**
31+
### 2. Add Private Repository
3432

3533
Add our private Composer repository to your `composer.json`:
3634

@@ -45,7 +43,7 @@ Choose your installation method based on your license type:
4543
}
4644
```
4745

48-
**Step 3: Install the package**
46+
### 3. Install Package
4947

5048
```bash
5149
composer require relaticle/custom-fields:^3.0
@@ -55,64 +53,45 @@ Choose your installation method based on your license type:
5553
- **Username**: Your email (used for purchase)
5654
- **Password**: Your license key
5755

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
5959

6060
```bash
6161
php artisan custom-fields:install
6262
```
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:
69-
70-
**`resources/css/filament/admin/theme.css`**
71-
72-
```css
73-
@source '../../../../vendor/relaticle/custom-fields/resources';
74-
```
75-
76-
Your license key will be saved in Composer's auth file for future updates.
7763
::
7864

7965
::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).
8867
89-
**Step 1: Install the package**
68+
### 1. Install Package
9069

9170
Install directly from Packagist:
9271

9372
```bash
9473
composer require relaticle/custom-fields:^3.0
9574
```
9675

97-
**Step 2: Run the installer**
76+
### 2. Run Installer
9877

9978
```bash
10079
php artisan custom-fields:install
10180
```
81+
::
82+
::
10283

103-
**Step 3: Include CSS assets**
84+
## Include CSS Assets
10485

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.
10687

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:
10889

109-
**`resources/css/filament/admin/theme.css`**
90+
**`resources/css/filament/admin/theme.css`**
11091

111-
```css
112-
@source '../../../../vendor/relaticle/custom-fields/resources';
113-
```
114-
::
115-
::
92+
```css
93+
@source '../../../../vendor/relaticle/custom-fields/resources';
94+
```
11695

11796
## Optional Configuration
11897

0 commit comments

Comments
 (0)