Skip to content

Commit 8e11063

Browse files
committed
Update docs
1 parent 758b10e commit 8e11063

File tree

7 files changed

+116
-43
lines changed

7 files changed

+116
-43
lines changed

docs/.vitepress/config.mts

Lines changed: 54 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,60 @@
1-
import { defineConfig } from 'vitepress'
1+
import {defineConfig} from 'vitepress'
22

33
// https://vitepress.dev/reference/site-config
44
export default defineConfig({
5-
title: "FilamentPHP Custom Fields",
6-
description: "Filament plugin that allows to add dynamic, user-defined form fields, enhancing the customization and functionality of admin panels.",
7-
base: '/custom-fields-community/',
8-
themeConfig: {
9-
// https://vitepress.dev/reference/default-theme-config
10-
nav: [
11-
{ text: 'Home', link: '/' },
12-
{ text: 'Documentation', link: '/introduction' },
13-
{ text: 'Buy', link: 'https://relaticle.lemonsqueezy.com/buy/803d5933-4b12-4869-9d93-f96797339603'}
14-
],
5+
title: "FilamentPHP Custom Fields",
6+
description: "Filament plugin that allows to add dynamic, user-defined form fields, enhancing the customization and functionality of admin panels.",
7+
base: '/custom-fields-community/',
8+
themeConfig: {
9+
// https://vitepress.dev/reference/default-theme-config
10+
nav: [
11+
{text: 'Home', link: '/'},
12+
{text: 'Documentation', link: '/introduction'},
13+
{text: 'Buy', link: 'https://relaticle.lemonsqueezy.com/buy/803d5933-4b12-4869-9d93-f96797339603'}
14+
],
1515

16-
sidebar: [
17-
{
18-
text: 'Getting Started',
19-
items: [
20-
{ text: 'Introduction', link: '/introduction' },
21-
{ text: 'Installation', link: '/installation' }
22-
]
23-
},
24-
{
25-
text: 'Usage',
26-
items: [
27-
{
28-
text: 'Setting Up', link: '/setting-up',
29-
},
30-
{
31-
text: 'Configuration', link: '/configuration'
32-
},
33-
{
34-
text: 'Presets', link: '/presets'
35-
}
36-
]
37-
}
38-
],
16+
sidebar: [
17+
{
18+
text: 'Getting Started',
19+
items: [
20+
{text: 'Introduction', link: '/introduction'},
21+
{text: 'Installation', link: '/installation'}
22+
]
23+
},
24+
{
25+
text: 'Usage',
26+
items: [
27+
{
28+
text: 'Setting Up', link: '/setting-up',
29+
},
30+
{
31+
text: 'Configuration', link: '/configuration'
32+
},
33+
{
34+
text: 'Presets', link: '/presets'
35+
}
36+
]
37+
},
38+
{
39+
text: 'Support & Contribution',
40+
items: [
41+
{text: 'Support', link: '/support'},
42+
{text: 'Contribution', link: '/contribution'}
43+
]
44+
},
45+
{
46+
text: 'About',
47+
items: [
48+
{text: 'License', link: '/license'},
49+
{text: 'Code Distribution', link: '/code-distribution'},
50+
{text: 'Changelog', link: '/changelog'}
51+
]
52+
}
53+
],
3954

40-
socialLinks: [
41-
{ icon: 'github', link: 'https://github.com/Relaticle' }
42-
]
43-
},
44-
ignoreDeadLinks: true
55+
socialLinks: [
56+
{icon: 'github', link: 'https://github.com/Relaticle'}
57+
]
58+
},
59+
ignoreDeadLinks: true
4560
})

docs/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## Changelog
2+
3+
Stay updated with the latest changes, improvements, and bug fixes.
4+
5+
[**View Changelog**](CHANGELOG.md)

docs/code-distribution.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Code Distribution
2+
3+
**Custom Fields** licenses strictly prohibit the public distribution of its source code. You may not:
4+
5+
- Build applications using Custom Fields and distribute them publicly via open-source repositories, hosting platforms,
6+
or any other code distribution platforms.
7+
8+
Violating this policy may result in license termination and potential legal action.

docs/contribution.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Contributing
2+
3+
We welcome contributions from the community! If you hold an active license, you can access the private repository to
4+
contribute.

docs/license.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
outline: deep
3+
---
4+
5+
# License
6+
7+
## Single License
8+
9+
The **Single License** grants permission to use Custom Fields in a single project hosted on one domain or subdomain.
10+
Suitable for personal websites or projects for a single client.
11+
12+
- **Usage**: Single project on one domain/subdomain
13+
- **Users**: Up to 5 Employees and Contractors
14+
- **Support & Updates**: Included for one year from the date of purchase
15+
- **Renewal**: Discounted renewal available after expiration to continue receiving updates and new features
16+
17+
*Note*: For SaaS applications or multiple projects, please refer to our other licensing options.
18+
19+
## Unlimited License
20+
21+
The **Unlimited License** allows the use of Custom Fields on unlimited domains and subdomains, including SaaS
22+
applications.
23+
24+
- **Usage**: Unlimited projects on multiple domains/subdomains
25+
- **Users**: Up to 25 Employees and Contractors
26+
- **Support & Updates**: Included for one year from the date of purchase
27+
- **Renewal**: Discounted renewal available after expiration to continue receiving updates and new features
28+
29+
## Lifetime License
30+
31+
The **Lifetime License** offers the same benefits as the Unlimited License with lifetime updates.
32+
33+
- **Usage**: Unlimited projects on multiple domains/subdomains
34+
- **Users**: Up to 25 Employees and Contractors
35+
- **Support & Updates**: Lifetime updates and bug fixes
36+
- **Renewal**: No renewal needed

docs/support.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Support
2+
3+
Need assistance? Encountered a bug? Have a feature request? We’re here to help!
4+
5+
- **Email**: [`customfieldsnext@gmail.com`](mailto:customfieldsnext@gmail.com)
6+
- **Bug Reports & Feature Requests**: [GitHub Issues](https://github.com/your-repo/issues) *(Replace with your actual
7+
repository link)*
8+
9+
Feel free to reach out with your queries, and we'll get back to you promptly.

docs/v1.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
outline: deep
3-
---
4-
51
# Custom Fields
62

73
## Table of Contents

0 commit comments

Comments
 (0)