Skip to content

Commit b86b0b9

Browse files
committed
docs: add documentation index and Spec Kit guide
Add comprehensive documentation index to README (EN + PT-BR): - Getting Started section with quick links - Architecture & Design docs - Development guides - Project management (roadmap, tasks) - Package documentation Create Spec Kit collaborative development guide: - Complete 7-step workflow explanation - Practical examples (file upload feature) - How to contribute using Spec Kit - Benefits for contributors - FAQ section Available in both English and Portuguese: - docs/SPEC_KIT_GUIDE.md - docs/pt-br/SPEC_KIT_GUIDE.md This enables the community to contribute using structured, collaborative development with clear specifications.
1 parent 0284f1c commit b86b0b9

4 files changed

Lines changed: 708 additions & 2 deletions

File tree

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,47 @@ Open-source platform for conversational forms powered by LLMs.
88

99
[English](./README.md) | [Português](./README.pt-BR.md)
1010

11-
**[Quick Start](#quick-start) · [Documentation](./docs) · [Architecture](./docs/ARCHITECTURE.md) · [Contributing](./CONTRIBUTING.md)**
11+
**[Quick Start](#quick-start) · [Documentation](#documentation-index) · [Architecture](./docs/ARCHITECTURE.md) · [Contributing](./CONTRIBUTING.md)**
12+
13+
---
14+
15+
## Documentation Index
16+
17+
### Getting Started
18+
- [Quick Start Guide](#quick-start) - Get up and running in 5 minutes
19+
- [Installation](#installation) - Detailed setup instructions
20+
- [Using @flowform/core](#using-flowformcore) - Core package usage
21+
22+
### Architecture & Design
23+
- [Architecture Overview](./docs/ARCHITECTURE.md) - Design decisions and patterns
24+
- [Project Specification](./docs/PROJECT_SPEC.md) - Complete technical specification
25+
- [ADRs (Architecture Decision Records)](./docs/adr/) - Major design decisions
26+
27+
### Development
28+
- [Development Guide](./docs/DEVELOPMENT.md) - Setup, workflow, troubleshooting
29+
- [Contributing Guide](./CONTRIBUTING.md) - How to contribute
30+
- [Spec Kit Guide](./docs/SPEC_KIT_GUIDE.md) - Collaborative development workflow
31+
- [Code Style](./CONTRIBUTING.md#code-style) - Coding standards
32+
33+
### Project Management
34+
- [Roadmap & Tasks](./docs/TASKS_MVP.md) - 11 phases, 300+ tasks
35+
- [Changelog](./CHANGELOG.md) - Version history and release notes
36+
- [v0.1.0 Release Notes](./docs/releases/v0.1.0.md) - Core orchestrator release
37+
38+
### Package Documentation
39+
- [@flowform/core README](./packages/core/README.md) - Core package API reference
40+
41+
### Contributing with Spec Kit
42+
43+
Flowform uses [Spec Kit](./docs/SPEC_KIT_GUIDE.md) for structured, collaborative development:
44+
45+
1. **Choose a feature** from [TASKS_MVP.md](./docs/TASKS_MVP.md)
46+
2. **Write a spec** using Spec Kit workflow
47+
3. **Get feedback** from community
48+
4. **Implement** with clear guidance
49+
5. **Ship it!**
50+
51+
New to Spec Kit? Read the [complete guide](./docs/SPEC_KIT_GUIDE.md) to understand how we build features collaboratively.
1252

1353
---
1454

README.pt-BR.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,47 @@ Plataforma open-source para formulários conversacionais com LLMs.
88

99
[English](./README.md) | [Português](./README.pt-BR.md)
1010

11-
**[Início Rápido](#início-rápido) · [Documentação](./docs/pt-br) · [Arquitetura](./docs/pt-br/ARCHITECTURE.md) · [Contribuindo](./CONTRIBUTING.pt-BR.md)**
11+
**[Início Rápido](#início-rápido) · [Documentação](#índice-de-documentação) · [Arquitetura](./docs/pt-br/ARCHITECTURE.md) · [Contribuindo](./CONTRIBUTING.pt-BR.md)**
12+
13+
---
14+
15+
## Índice de Documentação
16+
17+
### Começando
18+
- [Guia de Início Rápido](#início-rápido) - Configure em 5 minutos
19+
- [Instalação](#instalação) - Instruções detalhadas de setup
20+
- [Usando @flowform/core](#usando-flowformcore) - Uso do pacote core
21+
22+
### Arquitetura & Design
23+
- [Visão Geral da Arquitetura](./docs/pt-br/ARCHITECTURE.md) - Decisões de design e padrões
24+
- [Especificação do Projeto](./docs/PROJECT_SPEC.md) - Especificação técnica completa
25+
- [ADRs (Architecture Decision Records)](./docs/adr/) - Decisões de design importantes
26+
27+
### Desenvolvimento
28+
- [Guia de Desenvolvimento](./docs/pt-br/DEVELOPMENT.md) - Setup, workflow, troubleshooting
29+
- [Guia de Contribuição](./CONTRIBUTING.pt-BR.md) - Como contribuir
30+
- [Guia do Spec Kit](./docs/pt-br/SPEC_KIT_GUIDE.md) - Workflow de desenvolvimento colaborativo
31+
- [Estilo de Código](./CONTRIBUTING.pt-BR.md#estilo-de-código) - Padrões de código
32+
33+
### Gerenciamento do Projeto
34+
- [Roadmap & Tasks](./docs/TASKS_MVP.md) - 11 fases, 300+ tarefas
35+
- [Changelog](./CHANGELOG.pt-BR.md) - Histórico de versões e release notes
36+
- [Release Notes v0.1.0](./docs/releases/v0.1.0.md) - Release do core orchestrator
37+
38+
### Documentação de Pacotes
39+
- [@flowform/core README](./packages/core/README.md) - Referência da API do core
40+
41+
### Contribuindo com Spec Kit
42+
43+
Flowform usa [Spec Kit](./docs/pt-br/SPEC_KIT_GUIDE.md) para desenvolvimento estruturado e colaborativo:
44+
45+
1. **Escolha uma feature** de [TASKS_MVP.md](./docs/TASKS_MVP.md)
46+
2. **Escreva uma spec** usando workflow Spec Kit
47+
3. **Obtenha feedback** da comunidade
48+
4. **Implemente** com orientação clara
49+
5. **Shipar!**
50+
51+
Novo no Spec Kit? Leia o [guia completo](./docs/pt-br/SPEC_KIT_GUIDE.md) para entender como construímos features colaborativamente.
1252

1353
---
1454

0 commit comments

Comments
 (0)