Skip to content

Commit f41a93d

Browse files
committed
feat(docs): enhance index and contributing documentation for clarity and detail
1 parent 366dd69 commit f41a93d

File tree

3 files changed

+109
-11
lines changed

3 files changed

+109
-11
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Contributing
3+
description: How to contribute to Flowforge
4+
---
5+
6+
## Quick Start
7+
8+
1. **Fork** the repository
9+
2. **Create** a feature branch
10+
3. **Make** your changes
11+
4. **Run** tests: `composer test`
12+
5. **Submit** a pull request
13+
14+
## Guidelines
15+
16+
- Follow the existing code style
17+
- Add tests for new features
18+
- Update documentation as needed
19+
- One feature per pull request
20+
21+
## Development Commands
22+
23+
```bash
24+
# Run tests
25+
composer test
26+
27+
# Format code
28+
composer pint
29+
30+
# Static analysis
31+
composer analyse
32+
```
33+
34+
## Need Help?
35+
36+
- [Open an issue](https://github.com/relaticle/flowforge/issues) for bugs or questions
37+
- Check [existing issues](https://github.com/relaticle/flowforge/issues) first
38+
39+
That's it! Keep it simple and focused. 🚀
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: License
3+
description: MIT License terms and what it means for you
4+
---
5+
6+
## MIT License
7+
8+
```
9+
Copyright (c) Relaticle
10+
11+
Permission is hereby granted, free of charge, to any person obtaining a copy
12+
of this software and associated documentation files (the "Software"), to deal
13+
in the Software without restriction, including without limitation the rights
14+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15+
copies of the Software, and to permit persons to whom the Software is
16+
furnished to do so, subject to the following conditions:
17+
18+
The above copyright notice and this permission notice shall be included in
19+
all copies or substantial portions of the Software.
20+
21+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27+
THE SOFTWARE.
28+
```
29+
30+
## What This Means
31+
32+
**You can** use Flowforge in commercial projects
33+
**You can** modify and distribute it
34+
**You can** use it in closed source projects
35+
**You can** sell applications that include it
36+
37+
Just include the license notice in your copy. That's it!

docs/content/index.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,42 +50,64 @@ Why choose Flowforge?
5050
icon: i-lucide-zap
5151
---
5252
#title
53-
Production-Ready Performance
53+
Enterprise-Scale Performance
5454

5555
#description
56-
Handles 100+ cards per column with intelligent pagination, infinite scroll, and optimistic UI updates.
56+
Cursor-based pagination handles unlimited cards per column with intelligent loading and position-based ordering optimization.
5757
:::
5858

5959
:::u-page-feature
6060
---
61-
icon: i-lucide-clock
61+
icon: i-lucide-layers
6262
---
6363
#title
64-
Quick Setup
64+
3 Integration Patterns
6565

6666
#description
67-
Get running in 90 seconds. Add a position column, generate your board, and you're ready to go.
67+
Use as Filament Pages, Resource integration, or standalone Livewire components - whatever fits your architecture.
6868
:::
6969

7070
:::u-page-feature
7171
---
72-
icon: i-lucide-layers
72+
icon: i-lucide-palette
7373
---
7474
#title
75-
3 Integration Patterns
75+
Rich Card Schemas
7676

7777
#description
78-
Use as Filament Pages, Resource integration, or standalone Livewire components - whatever fits your needs.
78+
Filament Schema builder creates complex card layouts with forms, components, and dynamic content rendering.
7979
:::
8080

8181
:::u-page-feature
8282
---
83-
icon: i-lucide-palette
83+
icon: i-lucide-move
84+
---
85+
#title
86+
Smart Position Management
87+
88+
#description
89+
Advanced ranking algorithm handles unlimited drag-and-drop ordering with automatic conflict resolution and repair commands.
90+
:::
91+
92+
:::u-page-feature
93+
---
94+
icon: i-lucide-activity
95+
---
96+
#title
97+
Optimistic UI Experience
98+
99+
#description
100+
Instant visual feedback with loading states, smooth scrolling, and responsive drag interactions for seamless UX.
101+
:::
102+
103+
:::u-page-feature
104+
---
105+
icon: i-lucide-filter
84106
---
85107
#title
86-
Fully Customizable
108+
Native Filament Integration
87109

88110
#description
89-
Rich card schemas, custom actions, search & filtering, themes, and complete UI control.
111+
Deep integration with Filament's table system for filters, search, actions, and consistent admin panel experience.
90112
:::
91113
::

0 commit comments

Comments
 (0)