Skip to content

Commit 0d37e5a

Browse files
committed
feat: Update documentation to remove Discord references and improve clarity across multiple files
1 parent 14dcade commit 0d37e5a

19 files changed

+123
-140
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -737,9 +737,7 @@ Se você precisa de um framework com equipe dedicada e suporte empresarial, cons
737737

738738
Junte-se à nossa comunidade crescente de desenvolvedores:
739739

740-
- **Discord**: [Entre no nosso servidor](https://discord.gg/DMtxsP7z) - Obtenha ajuda, compartilhe ideias e conecte-se com outros desenvolvedores
741740
- **GitHub Discussions**: [Inicie uma discussão](https://github.com/PivotPHP/pivotphp-core/discussions) - Compartilhe feedback e ideias
742-
- **Twitter**: [@PivotPHP](https://twitter.com/pivotphp) - Siga para atualizações e anúncios
743741

744742
## 🤝 Como Contribuir
745743

RELEASE_v1.2.0.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# 🚀 PivotPHP Core v1.2.0 - Simplicity Edition
22
## "Simplicidade sobre Otimização Prematura"
33

4-
**Data de Lançamento**: 21 de Julho de 2025
5-
**Versão**: 1.2.0 (Simplicity Edition)
6-
**Compatibilidade**: PHP 8.1+ | 100% Backward Compatible
4+
**Data de Lançamento**: 21 de Julho de 2025
5+
**Versão**: 1.2.0 (Simplicity Edition)
6+
**Compatibilidade**: PHP 8.1+ | 100% Backward Compatible
77
**Status**: Estável para uso em produção
88

99
---
@@ -35,7 +35,7 @@ use PivotPHP\Core\Middleware\Http\ApiDocumentationMiddleware;
3535
// Ativar documentação automática em 3 linhas
3636
$app->use(new ApiDocumentationMiddleware([
3737
'docs_path' => '/docs', // JSON OpenAPI 3.0.0
38-
'swagger_path' => '/swagger', // Interface Swagger UI
38+
'swagger_path' => '/swagger', // Interface Swagger UI
3939
'base_url' => 'http://localhost:8080'
4040
]));
4141

@@ -292,13 +292,12 @@ A versão 1.2.0 "Simplicity Edition" marca um momento de maturidade do PivotPHP
292292
## 📞 **Suporte e Comunidade**
293293

294294
- **📚 Documentação**: [GitHub Wiki](https://github.com/PivotPHP/pivotphp-core/wiki)
295-
- **💬 Discord**: [Comunidade PivotPHP](https://discord.gg/DMtxsP7z)
296295
- **🐛 Issues**: [GitHub Issues](https://github.com/PivotPHP/pivotphp-core/issues)
297296
- **📖 Examples**: [Diretório examples/](examples/) com 11 exemplos práticos
298297
- **🎓 Tutoriais**: [docs/](docs/) com guias detalhados
299298

300299
---
301300

302-
**PivotPHP v1.2.0 - Onde simplicidade encontra performance. Onde produtividade encontra qualidade. Onde desenvolvedores encontram felicidade.**
301+
**PivotPHP v1.2.0 - Onde simplicidade encontra performance. Onde produtividade encontra qualidade. Onde desenvolvedores encontram felicidade.**
303302

304-
🚀 **Happy Coding!**
303+
🚀 **Happy Coding!**

docs/API_REFERENCE.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PivotPHP Core - API Reference
22

3-
**Version:** 1.2.0
4-
**Last Updated:** July 2025
3+
**Version:** 1.2.0
4+
**Last Updated:** July 2025
55

66
> ⚠️ **Nota**: Este projeto é mantido por apenas uma pessoa e pode não receber atualizações constantemente. Ideal para provas de conceito, protótipos e estudos, mas não recomendado para aplicações críticas de produção.
77
@@ -118,7 +118,7 @@ $app->get('/protected', $authMiddleware, function ($req, $res) {
118118

119119
#### Multiple Middleware
120120
```php
121-
$app->post('/api/data',
121+
$app->post('/api/data',
122122
$corsMiddleware,
123123
$authMiddleware,
124124
$validationMiddleware,
@@ -273,7 +273,7 @@ $app->get('/users', 'getUsersHandler');
273273
#### String Format (Does NOT work)
274274
```php
275275
// This will cause a TypeError!
276-
$app->get('/users', 'UserController@index');
276+
$app->get('/users', 'UserController@index');
277277
```
278278

279279
**Use this instead:**
@@ -299,7 +299,7 @@ PerformanceMode::disable();
299299

300300
**Performance Profiles:**
301301
- `PROFILE_DEVELOPMENT` - Development optimization
302-
- `PROFILE_PRODUCTION` - Production optimization
302+
- `PROFILE_PRODUCTION` - Production optimization
303303
- `PROFILE_TEST` - Test optimization
304304

305305
### JSON Optimization (v1.1.1+)
@@ -321,7 +321,7 @@ $stats = JsonBufferPool::getStatistics();
321321

322322
**Automatic Optimization:**
323323
- Arrays with 10+ elements use pooling
324-
- Objects with 5+ properties use pooling
324+
- Objects with 5+ properties use pooling
325325
- Strings >1KB use pooling
326326
- Smaller data uses traditional `json_encode()`
327327

@@ -331,11 +331,11 @@ $stats = JsonBufferPool::getStatistics();
331331
```php
332332
$middleware = function ($req, $res, $next) {
333333
// Pre-processing
334-
334+
335335
$response = $next($req, $res); // Continue to next middleware
336-
336+
337337
// Post-processing
338-
338+
339339
return $response;
340340
};
341341
```
@@ -346,7 +346,7 @@ $authMiddleware = function ($req, $res, $next) {
346346
if (!$req->header('Authorization')) {
347347
return $res->status(401)->json(['error' => 'Unauthorized']);
348348
}
349-
349+
350350
return $next($req, $res);
351351
};
352352
```
@@ -356,13 +356,13 @@ $authMiddleware = function ($req, $res, $next) {
356356
$enrichMiddleware = function ($req, $res, $next) {
357357
// Add data to request
358358
$req->startTime = microtime(true);
359-
359+
360360
$response = $next($req, $res);
361-
361+
362362
// Add headers to response
363363
$duration = microtime(true) - $req->startTime;
364364
$res->header('X-Response-Time', $duration . 'ms');
365-
365+
366366
return $response;
367367
};
368368
```
@@ -460,7 +460,7 @@ Application::VERSION // Current version string
460460

461461
Complete working examples are available in the `/examples` directory:
462462
- **01-basics** - Hello World, CRUD, Request/Response, JSON API
463-
- **02-routing** - Regex, Parameters, Groups, Constraints
463+
- **02-routing** - Regex, Parameters, Groups, Constraints
464464
- **03-middleware** - Custom, Stack, Auth, CORS
465465
- **04-api** - RESTful API with pagination and validation
466466
- **05-performance** - High-performance mode demonstrations
@@ -488,10 +488,9 @@ Complete working examples are available in the `/examples` directory:
488488

489489
## Community & Support
490490

491-
- **Discord**: https://discord.gg/DMtxsP7z
492491
- **GitHub**: https://github.com/PivotPHP/pivotphp-core
493492
- **Issues**: https://github.com/PivotPHP/pivotphp-core/issues
494493
- **Examples**: Ready-to-run examples in `/examples` directory
495494

496495
---
497-
**PivotPHP Core v1.1.3-dev** - Express.js for PHP 🐘⚡
496+
**PivotPHP Core v1.1.3-dev** - Express.js for PHP 🐘⚡

docs/MIGRATION_GUIDE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ If you encounter migration issues:
5555
1. **Check the specific migration guide** for your version
5656
2. **Review error messages** (now in Portuguese for clarity)
5757
3. **Consult the troubleshooting section** in the migration guide
58-
4. **Ask in Discord community**: https://discord.gg/DMtxsP7z
5958
5. **Create GitHub issue**: https://github.com/PivotPHP/pivotphp-core/issues
6059

6160
---

docs/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Welcome to the complete documentation for **PivotPHP Core v1.1.4** - a high-perf
1111

1212
### Core Guides
1313
- **[Architecture Guide](guides/architecture.md)** - v1.1.3 architecture overview
14-
- **[Performance Guide](guides/performance.md)** - Optimization and benchmarks
14+
- **[Performance Guide](guides/performance.md)** - Optimization and benchmarks
1515
- **[Testing Guide](guides/testing.md)** - Testing strategies and examples
1616

1717
### Reference Materials
@@ -50,7 +50,7 @@ scripts/quality/quality-check.sh # Consolidated validation
5050
scripts/release/version-bump.sh # Automatic version management
5151
```
5252

53-
### 📦 **Automatic Version Management**
53+
### 📦 **Automatic Version Management**
5454
- **VERSION file requirement** - Single source of truth
5555
- **Automatic version detection** - No more hardcoded versions
5656
- **Strict validation** - X.Y.Z semantic versioning enforced
@@ -73,7 +73,7 @@ scripts/release/version-bump.sh # Automatic version management
7373
- **Current Version**: v1.1.4 (Infrastructure Consolidation & Automation Edition)
7474
- **PHP Requirements**: 8.1+ with strict typing
7575
- **Production Ready**: Enterprise-grade quality with type safety
76-
- **Community**: [Discord](https://discord.gg/DMtxsP7z) | [GitHub](https://github.com/PivotPHP/pivotphp-core)
76+
- **Community**: [GitHub](https://github.com/PivotPHP)
7777

7878
## 🧩 Ecosystem
7979

@@ -84,7 +84,6 @@ scripts/release/version-bump.sh # Automatic version management
8484
### Community Resources
8585
- **[Benchmarks Repository](https://github.com/PivotPHP/pivotphp-benchmarks)** - Performance testing
8686
- **[Examples Collection](examples/)** - Practical usage examples
87-
- **[Community Discord](https://discord.gg/DMtxsP7z)** - Support and discussion
8887

8988
## 📖 Technical Documentation
9089

@@ -105,7 +104,7 @@ scripts/release/version-bump.sh # Automatic version management
105104

106105
Interested in contributing to PivotPHP Core? See our [Contributing Guide](contributing/README.md) for:
107106
- Development setup
108-
- Code style requirements
107+
- Code style requirements
109108
- Testing procedures
110109
- Pull request process
111110

@@ -115,4 +114,4 @@ PivotPHP Core is open-source software licensed under the [MIT License](../LICENS
115114

116115
---
117116

118-
*Built with ❤️ for the PHP community - Combining Express.js simplicity with PHP power*
117+
*Built with ❤️ for the PHP community - Combining Express.js simplicity with PHP power*

docs/VERSIONING_GUIDE.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ O PivotPHP Core segue rigorosamente o **Versionamento Semântico (SemVer)** no f
77
```
88
X.Y.Z
99
│ │ └─── PATCH: Correções de bugs (compatível com versões anteriores)
10-
│ └───── MINOR: Novas funcionalidades (compatível com versões anteriores)
10+
│ └───── MINOR: Novas funcionalidades (compatível com versões anteriores)
1111
└─────── MAJOR: Mudanças incompatíveis (quebra compatibilidade)
1212
```
1313

@@ -39,7 +39,7 @@ Incremente o número MAJOR quando fizer mudanças **incompatíveis** com versõe
3939
1. **Documentar breaking changes** detalhadamente
4040
2. **Criar guia de migração** (`MIGRATION_v2.0.0.md`)
4141
3. **Deprecar funcionalidades** por pelo menos 1 versão MINOR antes
42-
4. **Avisar a comunidade** com antecedência (Discord, GitHub)
42+
4. **Avisar a comunidade** com antecedência (GitHub)
4343
5. **Testar intensivamente** todas as mudanças
4444

4545
---
@@ -115,7 +115,7 @@ O PivotPHP Core inclui um script automatizado para gerenciar versões:
115115
# Incrementar PATCH (1.1.4 → 1.1.5)
116116
scripts/release/version-bump.sh patch
117117

118-
# Incrementar MINOR (1.1.4 → 1.2.0)
118+
# Incrementar MINOR (1.1.4 → 1.2.0)
119119
scripts/release/version-bump.sh minor
120120

121121
# Incrementar MAJOR (1.1.4 → 2.0.0)
@@ -196,7 +196,7 @@ Confirma o bump de 1.1.4 para 1.1.5? (y/N): y
196196
### Para MINOR e MAJOR:
197197

198198
#### ✅ Comunicação:
199-
- [ ] Anunciar no Discord da comunidade
199+
- [ ] Anunciar no GitHub da comunidade
200200
- [ ] Criar release notes detalhadas
201201
- [ ] Atualizar roadmap (se aplicável)
202202

@@ -284,7 +284,6 @@ git push origin main --tags
284284
- `scripts/quality/quality-check.sh` - Validação de qualidade
285285

286286
### Comunidade:
287-
- [Discord PivotPHP](https://discord.gg/DMtxsP7z)
288287
- [GitHub Issues](https://github.com/PivotPHP/pivotphp-core/issues)
289288
- [GitHub Discussions](https://github.com/PivotPHP/pivotphp-core/discussions)
290289

@@ -313,4 +312,4 @@ git push origin main --tags
313312

314313
---
315314

316-
*Última atualização: v1.1.4 - Documentação criada junto com consolidação de scripts*
315+
*Última atualização: v1.1.4 - Documentação criada junto com consolidação de scripts*

docs/contributing/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -565,8 +565,6 @@ Todos os contribuidores são reconhecidos:
565565

566566
- **GitHub Issues**: Para bugs e feature requests
567567
- **GitHub Discussions**: Para discussões gerais
568-
- **Email**: contato@pivotphp-core.com
569-
- **Discord**: [Link do servidor]
570568

571569
### Documentação Útil
572570

docs/quick-start.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ curl -X POST -H "Content-Type: application/json" \
7272
Use array callables with PHP 8.4+ compatibility:
7373

7474
```php
75-
class UserController
75+
class UserController
7676
{
77-
public function index($req, $res)
77+
public function index($req, $res)
7878
{
7979
return $res->json(['users' => User::all()]);
8080
}
81-
82-
public function show($req, $res)
81+
82+
public function show($req, $res)
8383
{
8484
$id = $req->param('id');
8585
return $res->json(['user' => User::find($id)]);
@@ -133,7 +133,7 @@ PivotPHP supports powerful routing patterns:
133133
// Basic parameters
134134
$app->get('/users/:id', $handler);
135135

136-
// Regex constraints
136+
// Regex constraints
137137
$app->get('/users/:id<\\d+>', $handler); // Only numeric IDs
138138
$app->get('/posts/:slug<[a-z0-9-]+>', $handler); // Slug format
139139

@@ -206,15 +206,15 @@ use PivotPHP\Core\Core\Application;
206206
class BasicTest extends TestCase
207207
{
208208
private Application $app;
209-
209+
210210
protected function setUp(): void
211211
{
212212
$this->app = new Application();
213213
$this->app->get('/test', function($req, $res) {
214214
return $res->json(['status' => 'ok']);
215215
});
216216
}
217-
217+
218218
public function testBasicRoute(): void
219219
{
220220
// Test implementation here
@@ -258,7 +258,6 @@ $app->use(new CorsMiddleware(['allowed_origins' => ['*']]));
258258
## 🆘 Suporte e Aprendizado
259259

260260
- **[Documentação](README.md)** - Documentação completa
261-
- **[Discord Community](https://discord.gg/DMtxsP7z)** - Suporte em tempo real
262261
- **[GitHub Issues](https://github.com/PivotPHP/pivotphp-core/issues)** - Relatar problemas e sugerir melhorias
263262
- **[Examples Repository](examples/)** - Exemplos práticos para aprendizado
264263

@@ -268,4 +267,4 @@ $app->use(new CorsMiddleware(['allowed_origins' => ['*']]));
268267

269268
---
270269

271-
**Parabéns!** Agora você tem uma base sólida para criar provas de conceito e protótipos com PivotPHP Core v1.2.0. 🎉
270+
**Parabéns!** Agora você tem uma base sólida para criar provas de conceito e protótipos com PivotPHP Core v1.2.0. 🎉

0 commit comments

Comments
 (0)