Skip to content

Commit b2a7fe8

Browse files
committed
feat(adoption): add roadmap examples and mcp ci
1 parent 933c982 commit b2a7fe8

20 files changed

Lines changed: 398 additions & 3 deletions

File tree

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Bug report
3+
about: Report a framework, script, docs, or MCP bug
4+
title: "[Bug] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
## Area
10+
11+
- [ ] Docs
12+
- [ ] Scripts
13+
- [ ] MCP
14+
- [ ] Validation / Gate
15+
- [ ] Example
16+
17+
## Current behavior
18+
19+
What happened?
20+
21+
## Expected behavior
22+
23+
What should have happened?
24+
25+
## Reproduction
26+
27+
Paste the exact command, prompt, or client setup used.
28+
29+
## Environment
30+
31+
- OS:
32+
- AI client:
33+
- Local or remote:

.github/ISSUE_TEMPLATE/use-case.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Use case
3+
about: Share a real project or adoption scenario for the framework
4+
title: "[Use case] "
5+
labels: use-case
6+
assignees: ""
7+
---
8+
9+
## Project type
10+
11+
- [ ] New project
12+
- [ ] Existing project
13+
- [ ] Internal team workflow
14+
- [ ] MCP client integration
15+
16+
## Short description
17+
18+
Describe the project in plain language.
19+
20+
## What you expected from the framework
21+
22+
Describe the result you wanted to get.
23+
24+
## Where friction appeared
25+
26+
List the first confusing step, missing guide, or missing automation.
27+
28+
## What would make this easier
29+
30+
Be concrete.

.github/workflows/mcp.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Validate MCP
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
mcp:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
16+
- name: Set up Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: 22
20+
cache: npm
21+
22+
- name: Install dependencies
23+
run: npm ci
24+
25+
- name: Typecheck
26+
run: npm run typecheck
27+
28+
- name: Build
29+
run: npm run build
30+
31+
- name: MCP stdio smoke test
32+
run: npm run mcp:smoke
33+
34+
- name: MCP HTTP smoke test
35+
run: npm run mcp:http:smoke

README.es.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,20 @@ npm run build
5656
3. Lee la guía de instalación:
5757
- [docs/es/33-guia-servidor-mcp.md](./docs/es/33-guia-servidor-mcp.md)
5858

59+
## 🎬 Flujo rápido de adopción
60+
61+
```mermaid
62+
flowchart LR
63+
A["Describe el proyecto en lenguaje simple"] --> B["Crea la base SDD"]
64+
B --> C["Aprueba la primera spec"]
65+
C --> D["Alinea plan y tareas"]
66+
D --> E["Valida + compuerta"]
67+
E --> F["Implementa solo después de consentimiento explícito"]
68+
```
69+
70+
Usa un ejemplo completo:
71+
- [examples/002-mcp-end-to-end/README.md](./examples/002-mcp-end-to-end/README.md)
72+
5973
## 🚨 Regla obligatoria antes de codificar
6074

6175
Este template exige chequeos de política y compuerta:
@@ -157,6 +171,7 @@ Paquete obligatorio por feature:
157171
- Esenciales: [Estructura](./docs/es/01-estructura.md) · [Flujo](./docs/es/02-flujo-de-trabajo.md)
158172
- IA: [Agentes soportados](./docs/es/10-agentes-ia-soportados-y-prompts.md) · [Guía Lovable](./docs/es/17-trabajar-con-lovable.md)
159173
- MCP: [Guía del servidor MCP](./docs/es/33-guia-servidor-mcp.md)
174+
- Roadmap: [Roadmap público](./docs/es/35-roadmap-publico.md)
160175
- Calidad: [Checklists por etapa](./docs/es/21-checklists-calidad-por-etapa.md) · [ADR](./docs/es/24-decisiones-de-arquitectura.md)
161176

162177
---

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,20 @@ npm run build
5656
3. Read the setup guide:
5757
- [docs/en/33-mcp-server-guide.md](./docs/en/33-mcp-server-guide.md)
5858

59+
## 🎬 Fast Adoption Flow
60+
61+
```mermaid
62+
flowchart LR
63+
A["Describe project in plain language"] --> B["Create SDD base"]
64+
B --> C["Approve first spec"]
65+
C --> D["Align plan and tasks"]
66+
D --> E["Validate + gate"]
67+
E --> F["Implement only after explicit consent"]
68+
```
69+
70+
Use a complete example:
71+
- [examples/002-mcp-end-to-end/README.md](./examples/002-mcp-end-to-end/README.md)
72+
5973
## 🚨 Mandatory Rule Before Coding
6074

6175
This template enforces policy + gate checks:
@@ -157,6 +171,7 @@ Mandatory spec bundle (for each feature):
157171
- Essentials: [Structure](./docs/en/01-structure.md) · [Workflow](./docs/en/02-workflow.md)
158172
- AI: [Supported Agents](./docs/en/10-supported-ai-agents-and-prompts.md) · [Lovable Guide](./docs/en/17-working-with-lovable.md)
159173
- MCP: [MCP Server Guide](./docs/en/33-mcp-server-guide.md)
174+
- Roadmap: [Public Roadmap](./docs/en/35-public-roadmap.md)
160175
- Quality: [Stage Checklists](./docs/en/21-quality-checklists-by-stage.md) · [ADR](./docs/en/24-architecture-decisions.md)
161176

162177
---

docs/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ flowchart LR
4747
- Spec Kit integration: [EN](./en/08-github-spec-kit-integration.md) | [ES](./es/08-integracion-github-spec-kit.md)
4848
- MCP server guide: [EN](./en/33-mcp-server-guide.md) | [ES](./es/33-guia-servidor-mcp.md)
4949
- Launch kit: [EN](./en/34-launch-kit.md) | [ES](./es/34-kit-lanzamiento.md)
50+
- Public roadmap: [EN](./en/35-public-roadmap.md) | [ES](./es/35-roadmap-publico.md)
5051
- Continuous refinement: [EN](./en/11-continuous-refinement.md) | [ES](./es/11-refinamiento-continuo.md)
5152
- Quality checklists: [EN](./en/21-quality-checklists-by-stage.md) | [ES](./es/21-checklists-calidad-por-etapa.md)
5253

@@ -56,8 +57,8 @@ flowchart LR
5657
- Validated prompt bank: [EN](./en/26-validated-prompt-bank.md) | [ES](./es/26-banco-prompts-validados.md)
5758

5859
## Full index / Índice completo
59-
- EN docs list: `docs/en/00` to `docs/en/34`
60-
- ES docs list: `docs/es/00` to `docs/es/34`
60+
- EN docs list: `docs/en/00` to `docs/en/35`
61+
- ES docs list: `docs/es/00` to `docs/es/35`
6162

6263
## Documentation audits / Auditorías de documentación
6364
- EN: [32-documentation-audit-2026-03-14](./en/32-documentation-audit-2026-03-14.md)

docs/en/09-release-checklist.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ Use this list before publishing on GitHub.
5151
- [ ] New users can follow the guide without extra context.
5252
- [ ] Scripts run correctly.
5353
- [ ] Repository metadata is complete.
54+
- [ ] `npm run typecheck` passes.
55+
- [ ] `npm run build` passes.
56+
- [ ] `npm run mcp:smoke` passes.
57+
- [ ] `npm run mcp:http:smoke` passes.
58+
- [ ] MCP docs and copy/paste configs are aligned with the current release.
59+
- [ ] Release tag/version/changelog are aligned.
5460

5561
## 💡 Quick tips
5662

docs/en/35-public-roadmap.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Public Roadmap
2+
3+
## Purpose
4+
5+
This roadmap makes the next product steps explicit so users know where the framework is going.
6+
7+
## Current state
8+
9+
Released:
10+
- `v1.1.0`
11+
12+
Now available:
13+
- SDD framework with multi-agent policy
14+
- runnable project isolation in `./www/<project-name>/`
15+
- typed `sdd-core`
16+
- local `sdd-mcp`
17+
- `stdio` + `Streamable HTTP`
18+
- MCP tools, resources, prompts, and smoke tests
19+
20+
## v1.2.0
21+
22+
Focus: stronger adoption and testability.
23+
24+
Planned:
25+
- fixture-based MCP integration tests
26+
- one fully documented end-to-end example for a new project
27+
- one fully documented end-to-end example for adapting an existing project
28+
- more explicit README visual onboarding
29+
- issue templates for adoption requests and use-case feedback
30+
31+
## v1.3.0
32+
33+
Focus: operator experience across AI clients.
34+
35+
Planned:
36+
- tested setup guides with screenshots for Cursor, Claude Code, and Codex
37+
- stricter MCP contracts and richer resource coverage
38+
- release automation improvements
39+
- better project status and roadmap generation outputs
40+
41+
## v2.0.0
42+
43+
Focus: framework standardization.
44+
45+
Planned:
46+
- clearer packaging/version strategy for `@sdd/sdd-core` and `@sdd/sdd-mcp`
47+
- optional publishable MCP package workflow
48+
- governance model for community contributions
49+
- showcase of real projects using the framework
50+
51+
## Notes
52+
53+
- GitHub Spec Kit remains the primary external reference and operating guide.
54+
- New features should continue reducing user friction, not increasing setup complexity.

docs/es/09-release-checklist.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,12 @@ git push origin v1.0.0
8585
- [ ] Cualquier persona puede seguir la guía sin pedir contexto adicional.
8686
- [ ] La plantilla se puede inicializar con `scripts/init-project.sh`.
8787
- [ ] La plantilla se puede inicializar con `scripts/init-project-with-spec-kit.sh`.
88+
- [ ] `npm run typecheck` pasa.
89+
- [ ] `npm run build` pasa.
90+
- [ ] `npm run mcp:smoke` pasa.
91+
- [ ] `npm run mcp:http:smoke` pasa.
92+
- [ ] La documentación MCP y las configuraciones copy/paste coinciden con la release actual.
93+
- [ ] Tag, versión y changelog están alineados.
8894

8995
## 💡 Tips rápidos
9096

docs/es/35-roadmap-publico.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Roadmap público
2+
3+
## Propósito
4+
5+
Este roadmap hace explícitos los siguientes pasos del producto para que los usuarios sepan hacia dónde va el framework.
6+
7+
## Estado actual
8+
9+
Release publicada:
10+
- `v1.1.0`
11+
12+
Disponible hoy:
13+
- framework SDD con política multi-agente
14+
- aislamiento de proyectos ejecutables en `./www/<project-name>/`
15+
- `sdd-core` tipado
16+
- `sdd-mcp` local
17+
- `stdio` + `Streamable HTTP`
18+
- tools, resources, prompts y smoke tests MCP
19+
20+
## v1.2.0
21+
22+
Enfoque: adopción y testabilidad más fuertes.
23+
24+
Planeado:
25+
- tests de integración MCP basados en fixtures
26+
- un ejemplo completamente documentado end-to-end para proyecto nuevo
27+
- un ejemplo completamente documentado end-to-end para adaptar un proyecto existente
28+
- onboarding visual más explícito en el README
29+
- issue templates para adopción y feedback de casos de uso
30+
31+
## v1.3.0
32+
33+
Enfoque: experiencia del operador entre distintos clientes IA.
34+
35+
Planeado:
36+
- guías validadas con capturas para Cursor, Claude Code y Codex
37+
- contratos MCP más estrictos y mayor cobertura de resources
38+
- mejoras en automatización de releases
39+
- mejores salidas para status y roadmap del proyecto
40+
41+
## v2.0.0
42+
43+
Enfoque: estandarización del framework.
44+
45+
Planeado:
46+
- estrategia de empaquetado/versionado más clara para `@sdd/sdd-core` y `@sdd/sdd-mcp`
47+
- flujo opcional para publicar el paquete MCP
48+
- modelo de gobernanza para contribuciones de comunidad
49+
- showcase de proyectos reales usando el framework
50+
51+
## Notas
52+
53+
- GitHub Spec Kit sigue siendo la referencia externa y guía operativa principal.
54+
- Las nuevas features deben seguir reduciendo fricción al usuario, no aumentar complejidad de setup.

0 commit comments

Comments
 (0)