Skip to content

Commit b51d7d2

Browse files
novincodenovincode
committed
feat: Update GitHub Actions workflows for improved dependency installation and add installation and release guides to documentation
1 parent e43b85e commit b51d7d2

5 files changed

Lines changed: 368 additions & 14 deletions

File tree

‎.github/workflows/build.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ jobs:
1414
- name: Checkout code
1515
uses: actions/checkout@v4
1616

17-
- name: Setup Node.js
18-
uses: actions/setup-node@v4
19-
with:
20-
node-version: '18'
21-
cache: 'npm'
22-
2317
- name: Install pnpm
2418
uses: pnpm/action-setup@v2
2519
with:
2620
version: 10.24.0
2721

22+
- name: Setup Node.js
23+
uses: actions/setup-node@v4
24+
with:
25+
node-version: '18'
26+
cache: 'pnpm'
27+
2828
- name: Install dependencies
29-
run: pnpm install --frozen-lockfile
29+
run: pnpm install
3030

3131
- name: Type check
3232
run: pnpm run type-check

‎.github/workflows/release.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ jobs:
1515
- name: Checkout code
1616
uses: actions/checkout@v4
1717

18-
- name: Setup Node.js
19-
uses: actions/setup-node@v4
20-
with:
21-
node-version: '18'
22-
cache: 'npm'
23-
2418
- name: Install pnpm
2519
uses: pnpm/action-setup@v2
2620
with:
2721
version: 10.24.0
2822

23+
- name: Setup Node.js
24+
uses: actions/setup-node@v4
25+
with:
26+
node-version: '18'
27+
cache: 'pnpm'
28+
2929
- name: Install dependencies
30-
run: pnpm install --frozen-lockfile
30+
run: pnpm install
3131

3232
- name: Build plugin
3333
run: pnpm run build:plugin:release

‎INSTALL.md‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# 📥 Installing OpenFields - User Guide
2+
3+
**For WordPress users who want to use OpenFields**
4+
5+
---
6+
7+
## The Easiest Way (Recommended)
8+
9+
### 1. Download
10+
Go to [OpenFields Releases](https://github.com/novincode/openfields/releases)
11+
12+
Find the latest release and download `openfields-X.X.X.zip`
13+
14+
### 2. Upload to WordPress
15+
1. Go to **WordPress Admin**
16+
2. Click **Plugins** in the left menu
17+
3. Click **Add New**
18+
4. Click **Upload Plugin**
19+
5. Select the `openfields-X.X.X.zip` file
20+
6. Click **Install Now**
21+
22+
### 3. Activate
23+
Click the **Activate Plugin** button
24+
25+
### 4. Start Using
26+
Go to **Tools → OpenFields** in the WordPress admin to create your first fieldset!
27+
28+
---
29+
30+
## Requirements
31+
32+
Your WordPress installation needs:
33+
34+
- **WordPress**: Version 6.0 or higher
35+
- **PHP**: Version 7.4 or higher
36+
- **Disk space**: ~5 MB for the plugin
37+
38+
Check your versions:
39+
- WordPress version: **WordPress Admin → Dashboard** (shown at bottom)
40+
- PHP version: **WordPress Admin → Tools → Site Health**
41+
42+
---
43+
44+
## What You Can Do
45+
46+
Once installed, you can:
47+
48+
✨ Create custom fields without coding
49+
📋 Create field groups and organize them
50+
🎯 Use conditional logic to show/hide fields
51+
📍 Display fields on posts, pages, users, or categories
52+
📤 Export and import your field configurations
53+
🔌 Access fields in your theme using simple functions
54+
55+
---
56+
57+
## Usage Example
58+
59+
### Create a Fieldset
60+
61+
1. Go to **Tools → OpenFields → Create New Fieldset**
62+
2. Name it (e.g., "Product Details")
63+
3. Add fields (Price, Description, etc.)
64+
4. Set location (Show on Product posts)
65+
5. Click Save
66+
67+
### Use Fields in Your Theme
68+
69+
In your theme file (like `single.php`):
70+
71+
```php
72+
<?php
73+
// Get a single field
74+
$price = get_field('price');
75+
echo 'Price: $' . $price;
76+
77+
// Or use it in a loop
78+
if (have_rows('features')) {
79+
while (have_rows('features')) {
80+
the_row();
81+
echo get_sub_field('feature_name');
82+
}
83+
}
84+
?>
85+
```
86+
87+
---
88+
89+
## Comparison to ACF
90+
91+
If you're familiar with Advanced Custom Fields (ACF):
92+
93+
| Feature | OpenFields | ACF |
94+
|---------|-----------|-----|
95+
| **Cost** | 100% Free | Free + Premium |
96+
| **Code License** | Open Source (GPL) | Proprietary |
97+
| **Basic API** | `get_field()` | `get_field()` |
98+
| **Can Modify** | Yes, it's open source | No, proprietary |
99+
| **Support** | Community | Paid support available |
100+
101+
**The API is designed to be familiar to ACF users!**
102+
103+
---
104+
105+
## Troubleshooting
106+
107+
### Plugin Won't Activate?
108+
- Check WordPress version (needs 6.0+)
109+
- Check PHP version (needs 7.4+)
110+
- Check browser console for JavaScript errors
111+
- Try reactivating the plugin
112+
113+
### Fields Don't Appear?
114+
- Check that fieldset is assigned to correct post type
115+
- Check location rules match your content
116+
- Refresh the page
117+
- Check browser console for errors
118+
119+
### Getting Errors?
120+
- Check **WordPress Admin → Tools → Site Health** for issues
121+
- Disable other plugins temporarily to test
122+
- Check **WordPress Admin → Tools → OpenFields** for error messages
123+
124+
---
125+
126+
## Getting Help
127+
128+
- 📖 **Documentation**: [openfields.codeideal.com/docs](https://openfields.codeideal.com/docs)
129+
- 🐛 **Report Issues**: [GitHub Issues](https://github.com/novincode/openfields/issues)
130+
- 💬 **Questions**: [GitHub Discussions](https://github.com/novincode/openfields/discussions)
131+
132+
---
133+
134+
## Next Steps
135+
136+
1. **Install OpenFields** (follow steps above)
137+
2. **Create your first fieldset** in Tools → OpenFields
138+
3. **Read the documentation** if you need help
139+
4. **Consider supporting the project** if you find it useful
140+
141+
---
142+
143+
## Why Choose OpenFields?
144+
145+
✅ **100% Free** - No premium tiers, ever
146+
✅ **Open Source** - Modify it however you want
147+
✅ **No Vendor Lock-in** - Your data is yours
148+
✅ **Active Development** - Regularly updated
149+
✅ **Community Driven** - Built by developers, for developers
150+
✅ **WordPress Standard** - Follows all best practices
151+
152+
---
153+
154+
**Happy building!** 🚀
155+
156+
Made with ❤️ by the OpenFields team

‎README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@
2121

2222
---
2323

24+
## 📖 Quick Links
25+
26+
| For Users | For Developers |
27+
|-----------|----------------|
28+
| **[📥 Installation Guide](./INSTALL.md)** | **[🤝 Contributing Guide](./CONTRIBUTING.md)** |
29+
| **[📚 User Documentation](https://openfields.codeideal.com/docs)** | **[📚 Developer Guide](./docs/DEVELOPER_GUIDE.md)** |
30+
| **[🚀 How to Release](./RELEASES.md)** | **[📖 All Documentation](./docs/INDEX.md)** |
31+
32+
---
33+
2434
## 📥 Installation
2535

2636
### Option 1: From GitHub (Easy Download)

0 commit comments

Comments
 (0)