Skip to content

Commit c417de3

Browse files
committed
📝 fix(docs): comprehensive documentation cleanup and correction
- Fixed corrupted UTF-8 emoji encoding across all language versions - Recreated Portuguese CONTRIBUTING.md from 471 lines to clean 267 lines - Recreated Portuguese STACKS.md with proper translation and structure - Corrected ADR status from 'planned' to 'implemented' in PT/ES versions - Fixed navigation links in Spanish README.md - Standardized emoji usage across EN/PT/ES documentation - Ensured consistency between all language versions - Verified all technical references match actual codebase BREAKING CHANGE: None Fixes documentation encoding issues and content duplications
1 parent 0686d7d commit c417de3

8 files changed

Lines changed: 113 additions & 376 deletions

File tree

docs/ARCHITECTURE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ graph TD
211211
- System is open for extension (new templates, commands)
212212
- Closed for modification (core logic remains stable)
213213

214-
## System Validation Architecture
214+
## 🔍 System Validation Architecture
215215

216216
### Dependency Validation System
217217

@@ -271,7 +271,7 @@ graph TD
271271
- **User Choice:** Option to proceed or cancel when dependencies are missing
272272
- **i18n Support:** Error messages localized in multiple languages
273273

274-
## 🛠️ Technology Stack
274+
## 🛠️ Technology Stack
275275

276276
### Core Technologies
277277

@@ -353,7 +353,7 @@ Each package follows consistent patterns:
353353
- **Template Generation:** Verify output correctness
354354
- **GitHub Integration:** API interaction testing
355355

356-
## Dependency Validation System
356+
## Dependency Validation System
357357

358358
### Architecture Overview
359359

@@ -402,7 +402,7 @@ const result = await validateStackDependencies("go");
402402
| `python` | `pip`, `python` ||
403403
| `node-js`, `node-ts`, `react`, `vue` | `npm` ||
404404

405-
## 🚀 Deployment and Distribution
405+
## 🚀 Deployment and Distribution
406406

407407
### NPM Packages
408408

docs/STACKS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
StackCode supports multiple technology stacks, each designed with best practices and optimal project structures. This document provides an overview of all **currently implemented** stacks based on the available templates in the core package.
44

5-
## Dependency Validation
5+
## 🔍 Dependency Validation
66

77
StackCode automatically validates that all required tools for your chosen stack are installed before proceeding with project creation. This ensures a smooth setup experience and prevents common installation errors.
88

@@ -28,7 +28,7 @@ StackCode automatically validates that all required tools for your chosen stack
2828

2929
> **💡 Tip**: If you see dependency warnings, you can still create the project structure. You'll just need to install the dependencies manually afterward.
3030
31-
## 📋 Currently Available Stacks
31+
## 📋 Currently Available Stacks
3232

3333
### Frontend Stacks
3434

@@ -253,7 +253,7 @@ StackCode automatically validates that all required tools for your chosen stack
253253
└── composer.json
254254
```
255255

256-
## Additional .gitignore Support
256+
## 📁 Additional .gitignore Support
257257

258258
Beyond the main project templates, StackCode provides comprehensive `.gitignore` support for:
259259

docs/es/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
¡Bienvenido al hub de documentación de StackCode! Este directorio contiene documentación completa para desarrolladores, contribuidores y organizaciones que usan StackCode.
44

5-
## Navegación Rápida
5+
## 📋 Navegación Rápida
66

77
### 🏗️ **Documentación Principal**
88

@@ -21,7 +21,7 @@
2121

2222
### 🌐 **Traducciones**
2323

24-
- **[🇪🇸 Español](es/)** - Documentación en español _(actual)_
24+
- **[🇪🇸 Español](.)** - Documentación en español _(actual)_
2525
- **[🇧🇷 Português (Brasil)](../pt-BR/)** - Documentação em português
2626
- **[🇺🇸 English](../)** - English documentation _(original)_
2727

@@ -43,7 +43,7 @@ Comienza aquí si quieres contribuir a StackCode:
4343
2. [Guía de Arquitectura](ARCHITECTURE.md) - Entiende la base de código
4444
3. [Directorio ADR](adr/) - Aprende sobre decisiones arquitecturales
4545

46-
### **Para Organizaciones**
46+
### 🏢 **Para Organizaciones**
4747

4848
Comienza aquí si quieres desplegar StackCode internamente:
4949

docs/es/adr/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
# Registros de Decisiones Arquitecturales (ADRs)
1+
# Registros de Decisio## Índice
2+
3+
Decisiones arquitectónicas actualmente documentadas:
4+
5+
- **[ADR-001: Estructura Monorepo](./001-monorepo-structure.md)** - Decisión de organizar el proyecto como un monorepo con npm workspaces
6+
- **[ADR-002: TypeScript y ES Modules](./002-typescript-esm.md)** - Elección de TypeScript con ESM como stack de desarrollo principal
7+
- **[ADR-003: Diseño de Interfaz de Línea de Comandos](./003-cli-design.md)** - Selección del framework CLI y arquitectura de comandos
8+
- **[ADR-004: Estrategia de Internacionalización](./004-i18n-strategy.md)** - Enfoque de implementación de soporte multi-idiomaitecturales (ADRs)
29

310
_Esta es una traducción del documento original en inglés. Para la versión más actualizada, consulte [docs/adr/README.md](../../adr/README.md)._
411

docs/pt-BR/CONTRIBUTING.md

Lines changed: 15 additions & 218 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Obrigado por considerar contribuir com o StackCode! Este guia fornece todas as i
44

55
## 📋 Navegação Rápida
66

7-
- **[Visão Geral da Arquitetura](#architecture-overview)** - Entenda a estrutura do projeto
8-
- **[Configuração de Desenvolvimento](#development-setup)** - Prepare seu ambiente
9-
- **[Tipos de Contribuição](#how-to-contribute)** - Diferentes formas de contribuir
10-
- **[Padrões de Código](#coding-standards)** - Siga nossas diretrizes
11-
- **[Internacionalização](#internationalization)** - Ajude com traduções
7+
- **[Visão Geral da Arquitetura](#visão-geral-da-arquitetura)** - Entenda a estrutura do projeto
8+
- **[Configuração de Desenvolvimento](#configuração-de-desenvolvimento)** - Prepare seu ambiente
9+
- **[Como Contribuir](#como-contribuir)** - Diferentes formas de contribuir
10+
- **[Padrões de Código](#padrões-de-código)** - Siga nossas diretrizes
11+
- **[Internacionalização](#internacionalização)** - Ajude com traduções
1212

1313
## 🏗️ Visão Geral da Arquitetura
1414

@@ -76,20 +76,26 @@ Entender a arquitetura ajudará você a:
7676

7777
- Corrija erros de digitação, melhore a clareza, adicione exemplos
7878
- Atualize docs ao adicionar novos recursos
79-
- Ajude com traduções (veja [Internacionalização](#internationalization))
79+
- Ajude com traduções (veja [Internacionalização](#internacionalização))
8080

8181
### 🛠️ Contribuições de Código
8282

8383
- Escolha issues marcadas com `good-first-issue` ou `help-wanted`
84-
- Siga o [fluxo de trabalho de desenvolvimento](#development-workflow)
84+
- Siga o [fluxo de trabalho de desenvolvimento](#fluxo-de-trabalho-de-desenvolvimento)
8585
- Garanta que todos os testes passem
8686
- Adicione testes para nova funcionalidade
8787

8888
### 🌐 Adicionando Novos Stacks de Tecnologia
8989

9090
Veja o guia abrangente em [CONTRIBUTING.md principal](../../CONTRIBUTING.md#adding-new-technology-stacks).
9191

92-
## � Fluxo de Trabalho de Desenvolvimento
92+
**Importante**: Ao adicionar novos stacks, garanta que você atualize o sistema de validação de dependências:
93+
94+
- Adicionando dependências do stack a `getStackDependencies()` em `packages/core/src/utils.ts`
95+
- Adicionando instruções de instalação aos arquivos i18n (`packages/i18n/src/locales/`)
96+
- Testando o fluxo de validação com e sem as ferramentas necessárias instaladas
97+
98+
## 🔄 Fluxo de Trabalho de Desenvolvimento
9399

94100
1. **Criar um Branch de Feature**
95101

@@ -125,7 +131,7 @@ Veja o guia abrangente em [CONTRIBUTING.md principal](../../CONTRIBUTING.md#addi
125131
# Abra PR contra o branch develop
126132
```
127133

128-
## 🎨 Padrões de Codificação
134+
## 🎨 Padrões de Código
129135

130136
### Princípios Gerais
131137

@@ -259,212 +265,3 @@ Para mais detalhes, veja:
259265
- **[README Principal](../../README.md)** - Visão geral do projeto
260266
- **[Guia de Arquitetura](ARCHITECTURE.md)** - Detalhes técnicos
261267
- **[Guia de Auto-hospedagem](SELF_HOSTING_GUIDE.md)** - Opções de deployment
262-
node packages/cli/dist/index.js --help
263-
264-
```
265-
266-
```
267-
268-
## 🤝 How to Contribute
269-
270-
### 🐛 Bug Reports
271-
272-
- Check [existing issues](https://github.com/YagoBorba/StackCode/issues) first
273-
- Provide clear reproduction steps
274-
- Include environment details (OS, Node.js version, etc.)
275-
- Use the bug report template
276-
277-
### ✨ Feature Requests
278-
279-
- Open an issue to discuss the feature first
280-
- Explain the use case and benefits
281-
- Consider if it fits the project's scope
282-
- Provide implementation ideas if possible
283-
284-
### 📝 Documentation Improvements
285-
286-
- Fix typos, improve clarity, add examples
287-
- Update docs when adding new features
288-
- Help with translations (see [Internationalization](#internationalization))
289-
290-
### 🛠️ Code Contributions
291-
292-
- Pick up issues labeled `good-first-issue` or `help-wanted`
293-
- Follow the [development workflow](#development-workflow)
294-
- Ensure all tests pass
295-
- Add tests for new functionality
296-
297-
### 🌐 Adding New Technology Stacks
298-
299-
See the comprehensive guide in [main CONTRIBUTING.md](../CONTRIBUTING.md#adding-new-technology-stacks).
300-
301-
## 🔄 Development Workflow
302-
303-
1. **Create a Feature Branch**
304-
305-
```bash
306-
git checkout develop
307-
git pull origin develop
308-
git checkout -b feat/your-feature-name
309-
```
310-
311-
2. **Make Your Changes**
312-
- Follow coding standards
313-
- Add tests for new functionality
314-
- Update documentation as needed
315-
316-
3. **Test Thoroughly**
317-
318-
```bash
319-
npm test
320-
npm run lint
321-
npm run build
322-
```
323-
324-
4. **Commit Your Changes**
325-
326-
```bash
327-
# Use conventional commits with emojis
328-
git commit -m "feat(cli): ✨ add new project template"
329-
```
330-
331-
5. **Push and Create PR**
332-
```bash
333-
git push origin feat/your-feature-name
334-
# Open PR against develop branch
335-
```
336-
337-
## 🎨 Coding Standards
338-
339-
### General Principles
340-
341-
- **Clean Code**: Write readable, maintainable code
342-
- **SOLID Principles**: Follow SOLID design principles
343-
- **Single Responsibility**: Each function/class should have one purpose
344-
- **Documentation**: Use TSDoc comments for public APIs
345-
346-
### TypeScript Guidelines
347-
348-
- Use strict TypeScript configuration
349-
- Prefer explicit types over `any`
350-
- Use interfaces for object shapes
351-
- Follow ESLint rules
352-
353-
### Testing Requirements
354-
355-
- Add unit tests for new functionality
356-
- Maintain or improve test coverage
357-
- Test both success and error scenarios
358-
- Use descriptive test names
359-
360-
## 🌐 Internacionalização
361-
362-
Aceitamos contribuições para suporte a mais idiomas:
363-
364-
### Current Structure
365-
366-
```
367-
packages/i18n/src/locales/
368-
├── en.json # English (primary)
369-
└── pt.json # Portuguese
370-
```
371-
372-
### Adding New Languages
373-
374-
1. **Create Locale File**
375-
376-
```bash
377-
# Example for Spanish
378-
cp packages/i18n/src/locales/en.json packages/i18n/src/locales/es.json
379-
```
380-
381-
2. **Translate Strings**
382-
383-
```json
384-
{
385-
"commands": {
386-
"init": {
387-
"description": "Inicializar un nuevo proyecto"
388-
}
389-
}
390-
}
391-
```
392-
393-
3. **Test the Translation**
394-
```bash
395-
STACKCODE_LANG=es node packages/cli/dist/index.js --help
396-
```
397-
398-
### Future Structure (Planned)
399-
400-
```
401-
docs/
402-
├── pt-BR/ # Portuguese (Brazil)
403-
├── es/ # Spanish
404-
├── fr/ # French
405-
└── de/ # German
406-
```
407-
408-
## 📏 Code Review Process
409-
410-
### For Contributors
411-
412-
- Keep PRs focused and small
413-
- Write clear PR descriptions
414-
- Respond to feedback promptly
415-
- Update documentation as needed
416-
417-
### Review Criteria
418-
419-
- Code quality and maintainability
420-
- Test coverage and quality
421-
- Documentation completeness
422-
- Adherence to project standards
423-
- Breaking change considerations
424-
425-
## 🏷️ Issue Labels
426-
427-
- `good-first-issue` - Perfect for newcomers
428-
- `help-wanted` - Community help needed
429-
- `bug` - Something isn't working
430-
- `enhancement` - New feature or improvement
431-
- `documentation` - Documentation related
432-
- `question` - Further information needed
433-
434-
## 📋 Contribution Checklist
435-
436-
Before submitting your PR, ensure:
437-
438-
- [ ] Code follows project standards
439-
- [ ] Tests are added and passing
440-
- [ ] Documentation is updated
441-
- [ ] Commit messages follow convention
442-
- [ ] PR targets the `develop` branch
443-
- [ ] Breaking changes are documented
444-
- [ ] Performance impact is considered
445-
446-
## 🆘 Getting Help
447-
448-
Need help contributing?
449-
450-
- **[GitHub Discussions](https://github.com/YagoBorba/StackCode/discussions)** - Ask questions
451-
- **[Discord/Slack](#)** - Real-time community chat (if available)
452-
- **[Issues](https://github.com/YagoBorba/StackCode/issues)** - Report problems
453-
454-
## 🙏 Recognition
455-
456-
All contributors are recognized in:
457-
458-
- [Contributors section](../README.md#contributors) in README
459-
- Git commit history
460-
- Release notes for significant contributions
461-
462-
Thank you for helping make StackCode better! 🚀
463-
464-
---
465-
466-
For more details, see:
467-
468-
- **[Main README](../README.md)** - Project overview
469-
- **[Architecture Guide](ARCHITECTURE.md)** - Technical details
470-
- **[Self-Hosting Guide](SELF_HOSTING_GUIDE.md)** - Deployment options

docs/pt-BR/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Bem-vindo ao hub de documentação do StackCode! Este diretório contém documentação abrangente para desenvolvedores, contribuidores e organizações que usam o StackCode.
44

5-
## Navegação Rápida
5+
## 📋 Navegação Rápida
66

77
### 🏗️ **Documentação Principal**
88

@@ -43,7 +43,7 @@ Comece aqui se você quer contribuir com o StackCode:
4343
2. [Guia de Arquitetura](ARCHITECTURE.md) - Entenda a base de código
4444
3. [Diretório ADR](adr/) - Aprenda sobre decisões arquiteturais
4545

46-
### **Para Organizações**
46+
### 🏢 **Para Organizações**
4747

4848
Comece aqui se você quer implantar o StackCode internamente:
4949

0 commit comments

Comments
 (0)