docs: add README, boost skill, and documentation site

This commit is contained in:
manukminasyan
2026-03-27 00:29:57 +04:00
parent 29fcbd8aec
commit b8d930df1a
25 changed files with 1741 additions and 3 deletions

View File

@@ -0,0 +1 @@
title: Community

View File

@@ -0,0 +1,39 @@
---
title: Contributing
description: How to contribute to Comments
navigation:
icon: i-lucide-heart-handshake
---
## Quick Start
1. **Fork** the repository
2. **Create** a feature branch
3. **Make** your changes
4. **Run** tests: `composer test`
5. **Submit** a pull request
## Guidelines
- Follow the existing code style
- Add tests for new features
- Update documentation as needed
- One feature per pull request
## Development Commands
```bash
# Run tests
composer test
# Format code
composer pint
# Static analysis
composer analyse
```
## Need Help?
- [Open an issue](https://github.com/relaticle/comments/issues) for bugs or questions
- Check [existing issues](https://github.com/relaticle/comments/issues) first

View File

@@ -0,0 +1,39 @@
---
title: License
description: MIT License terms and what it means for you
navigation:
icon: i-lucide-scale
---
## MIT License
```
Copyright (c) Relaticle
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```
## What This Means
You **can** use Comments in commercial projects.
You **can** modify and distribute it.
You **can** use it in closed source projects.
You **can** sell applications that include it.
Just include the license notice in your copy.