Welcome to the StackCode documentation hub! This directory contains comprehensive documentation for developers, contributors, and organizations using StackCode.
- 📐 Architecture Guide - Complete technical overview of the monorepo structure, design principles, and component interactions
- 🛠️ Technology Stacks - Detailed list of supported frameworks, templates, and project types
- 🤝 Contributing Guide - Everything you need to know to contribute to StackCode
- 🚀 Self-Hosting Guide - Deploy and customize StackCode for your organization
- ADR Directory - Architectural Decision Records documenting key design choices
- 🇧🇷 Português (Brasil) - Documentação em português
- 🇪🇸 Español - Documentación en español
Start here if you want to use StackCode in your projects:
- Main README - Project overview and getting started
- Technology Stacks - See what project types are supported
- Self-Hosting Guide - Deploy for your organization
Start here if you want to contribute to StackCode:
- Contributing Guide - How to contribute effectively
- Architecture Guide - Understand the codebase
- ADR Directory - Learn about architectural decisions
Start here if you want to deploy StackCode internally:
- Self-Hosting Guide - Deployment and customization
- Architecture Guide - Technical overview
- Contributing Guide - How to contribute improvements back
docs/
├── README.md # This file
├── ARCHITECTURE.md # Technical architecture
├── CONTRIBUTING.md # Contribution guidelines
├── SELF_HOSTING_GUIDE.md # Deployment guide
├── STACKS.md # Supported technologies
├── adr/ # Architecture Decision Records
│ ├── README.md
│ ├── 001-monorepo-structure.md
│ ├── 002-typescript-esm.md
│ ├── 003-cli-design.md
│ └── 004-i18n-strategy.md
├── pt-BR/ # Portuguese translations
│ └── README.md
└── es/ # Spanish translations
└── README.md
- Monorepo Architecture: StackCode uses a monorepo with multiple packages
- Template System: Configurable project templates for different technologies
- CLI + VS Code Extension: Multiple interfaces for the same core functionality
- Internationalization: Multi-language support across all interfaces
We welcome improvements to our documentation! Here's how to help:
- Fix typos, broken links, or unclear explanations
- Add examples or improve existing ones
- Update outdated information
- Write new guides or tutorials
- Create documentation for new features
- Help with translations
- Translate existing documentation to your language
- Review translations by other contributors
- Maintain consistency across translations
See our Contributing Guide for detailed instructions.
- GitHub Repository - Source code and issues
- NPM Package - Published CLI package
- VS Code Extension - VS Code Marketplace
Need help with StackCode?
- GitHub Issues - Bug reports and feature requests
- GitHub Discussions - Questions and community support
- Contributing Guide - How to get involved
Last updated: September 2025 | StackCode Documentation Team