@damenor/agent-docs 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +115 -0
- package/dist/index.js +568 -0
- package/package.json +53 -0
- package/templates/base/AGENTS.md +177 -0
- package/templates/base/CHANGELOG.md +86 -0
- package/templates/base/README.md +110 -0
- package/templates/base/docs/CONTEXT.md +111 -0
- package/templates/base/docs/README.md +131 -0
- package/templates/base/docs/adr/TEMPLATE.md +83 -0
- package/templates/modules/agents/.agents/agents/doc-designer.md +56 -0
- package/templates/modules/agents/.agents/agents/doc-maintainer.md +54 -0
- package/templates/modules/agents/.agents/agents/doc-reviewer.md +80 -0
- package/templates/modules/agents/.agents/agents/doc-writer.md +66 -0
- package/templates/modules/agents/.agents/agents/reviewer.md +138 -0
- package/templates/modules/agents/.agents/skills/doc-design/SKILL.md +359 -0
- package/templates/modules/agents/.agents/skills/doc-design/references/design-system-format.md +550 -0
- package/templates/modules/agents/.agents/skills/doc-maintain/SKILL.md +345 -0
- package/templates/modules/agents/.agents/skills/doc-maintain/references/triggers.md +311 -0
- package/templates/modules/agents/.agents/skills/doc-review/SKILL.md +324 -0
- package/templates/modules/agents/.agents/skills/doc-review/references/health-checklist.md +290 -0
- package/templates/modules/agents/.agents/skills/doc-scaffold/SKILL.md +277 -0
- package/templates/modules/agents/.agents/skills/doc-scaffold/references/diataxis-quick-ref.md +149 -0
- package/templates/modules/agents/.agents/skills/doc-write/SKILL.md +414 -0
- package/templates/modules/agents/.agents/skills/doc-write/references/adr-format.md +194 -0
- package/templates/modules/agents/.agents/skills/doc-write/references/diataxis-patterns.md +351 -0
- package/templates/modules/ci/.github/workflows/docs-check.yml +94 -0
- package/templates/modules/design/docs/DESIGN.md +253 -0
- package/templates/modules/explanation/docs/explanation/agent-flow.md +15 -0
- package/templates/modules/explanation/docs/explanation/architecture.md +138 -0
- package/templates/modules/guides/docs/guides/deployment.md +189 -0
- package/templates/modules/guides/docs/guides/runbooks/TEMPLATE.md +86 -0
- package/templates/modules/guides/docs/guides/troubleshooting.md +65 -0
- package/templates/modules/operations/docs/operations/README.md +115 -0
- package/templates/modules/product/docs/product/overview.md +90 -0
- package/templates/modules/product/docs/roadmap.md +80 -0
- package/templates/modules/reference/docs/reference/api.md +131 -0
- package/templates/modules/reference/docs/reference/code-style.md +275 -0
- package/templates/modules/reference/docs/reference/configuration.md +117 -0
- package/templates/modules/reference/docs/reference/infrastructure.md +191 -0
- package/templates/modules/tutorials/docs/tutorials/environment-setup.md +212 -0
- package/templates/modules/tutorials/docs/tutorials/first-task.md +246 -0
- package/templates/modules/tutorials/docs/tutorials/quick-start.md +146 -0
- package/templates/shared/.editorconfig +20 -0
- package/templates/shared/.markdownlint.json +14 -0
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
created: "2025-01-01"
|
|
3
|
+
status: active
|
|
4
|
+
type: tutorial
|
|
5
|
+
tags: [tutorial, quick-start, inicio, setup]
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Quick Start — Arrancar en 15 minutos
|
|
9
|
+
|
|
10
|
+
Este tutorial te lleva desde cero hasta tener el proyecto corriendo localmente. Al terminar, tendrás el servidor de desarrollo funcionando y podrás hacer tu primer cambio.
|
|
11
|
+
|
|
12
|
+
**Tiempo estimado**: 15 minutos.
|
|
13
|
+
**Audiencia**: Developers que se incorporan al proyecto por primera vez.
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Prerrequisitos
|
|
18
|
+
|
|
19
|
+
Antes de empezar, necesitas tener instalado:
|
|
20
|
+
|
|
21
|
+
| Herramienta | Versión mínima | Cómo verificar | Cómo instalar |
|
|
22
|
+
|------------|---------------|----------------|---------------|
|
|
23
|
+
| **[Node.js / Python / etc.]** | [versión] | `[node --version]` | [nodejs.org / enlace] |
|
|
24
|
+
| **[Git]** | [versión] | `git --version` | [git-scm.com] |
|
|
25
|
+
| **[Package manager]** | [versión] | `[npm --version]` | Viene con Node.js |
|
|
26
|
+
| **[Editor recomendado]** | — | — | [VS Code / etc.] |
|
|
27
|
+
|
|
28
|
+
Si necesitas ayuda con la instalación completa, ver [`environment-setup.md`](environment-setup.md).
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Paso 1: Clonar el repositorio
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
git clone [URL_DEL_REPOSITORIO]
|
|
36
|
+
cd [NOMBRE_DEL_PROYECTO]
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Verificar que estás en la branch correcta:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
git branch
|
|
43
|
+
# Debería mostrar: * main
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## Paso 2: Instalar dependencias
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
[npm install]
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Este comando descarga todas las dependencias del proyecto. Si hay errores:
|
|
55
|
+
|
|
56
|
+
- Verificar que la versión de [Node / Python] sea la correcta.
|
|
57
|
+
- Borrar `[node_modules]` y `[package-lock.json]` y volver a ejecutar.
|
|
58
|
+
- Si persiste, ver [`troubleshooting.md`](../guides/troubleshooting.md).
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
## Paso 3: Configurar variables de entorno
|
|
63
|
+
|
|
64
|
+
Copiar el archivo de ejemplo:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
cp .env.example .env
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Abrir `.env` y completar los valores necesarios. Los valores mínimos para desarrollo local son:
|
|
71
|
+
|
|
72
|
+
```env
|
|
73
|
+
# Obligatorios para arrancar
|
|
74
|
+
APP_ENV=development
|
|
75
|
+
APP_PORT=3000
|
|
76
|
+
[DATABASE_URL]=[URL de desarrollo local]
|
|
77
|
+
|
|
78
|
+
# Opcionales (tienen defaults para desarrollo)
|
|
79
|
+
[LOG_LEVEL]=debug
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Ver la referencia completa de variables en [`docs/reference/configuration.md`](../reference/configuration.md).
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## Paso 4: Inicializar la base de datos *(si aplica)*
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
[comando de migración — ej. npm run db:migrate]
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Opcionalmente, cargar datos de prueba:
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
[comando de seed — ej. npm run db:seed]
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## Paso 5: Arrancar el servidor de desarrollo
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
[npm run dev]
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Deberías ver algo como:
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
✓ Servidor iniciado en http://localhost:3000
|
|
110
|
+
✓ Hot-reload activo
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Abrir `http://localhost:3000` en el navegador. Deberías ver [la página principal / el dashboard / la landing].
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## Paso 6: Verificar que todo funciona
|
|
118
|
+
|
|
119
|
+
Ejecutar los tests:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
[npm run test]
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Todos deberían pasar (verde). Si algún test falla:
|
|
126
|
+
|
|
127
|
+
- Verificar que la base de datos esté configurada correctamente.
|
|
128
|
+
- Verificar que las variables de entorno estén completas.
|
|
129
|
+
- Ver [`troubleshooting.md`](../guides/troubleshooting.md).
|
|
130
|
+
|
|
131
|
+
Ejecutar el linter:
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
[npm run lint]
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
No debería mostrar errores.
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
## Siguientes pasos
|
|
142
|
+
|
|
143
|
+
- Para configurar tu entorno completo (editor, extensiones, herramientas): [`environment-setup.md`](environment-setup.md).
|
|
144
|
+
- Para hacer tu primera contribución (branch → código → PR): [`first-task.md`](first-task.md).
|
|
145
|
+
- Para entender la arquitectura del proyecto: [`docs/explanation/architecture.md`](../explanation/architecture.md).
|
|
146
|
+
- Para conocer el vocabulario del dominio: [`docs/CONTEXT.md`](../CONTEXT.md).
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
root = true
|
|
2
|
+
|
|
3
|
+
[*]
|
|
4
|
+
end_of_line = lf
|
|
5
|
+
insert_final_newline = true
|
|
6
|
+
trim_trailing_whitespace = true
|
|
7
|
+
charset = utf-8
|
|
8
|
+
|
|
9
|
+
[*.md]
|
|
10
|
+
indent_style = space
|
|
11
|
+
indent_size = 2
|
|
12
|
+
trim_trailing_whitespace = false
|
|
13
|
+
|
|
14
|
+
[*.{yml,yaml}]
|
|
15
|
+
indent_style = space
|
|
16
|
+
indent_size = 2
|
|
17
|
+
|
|
18
|
+
[*.json]
|
|
19
|
+
indent_style = space
|
|
20
|
+
indent_size = 2
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"default": true,
|
|
3
|
+
"MD001": true,
|
|
4
|
+
"MD003": { "style": "atx" },
|
|
5
|
+
"MD004": { "style": "dash" },
|
|
6
|
+
"MD013": false,
|
|
7
|
+
"MD024": { "siblings_only": true },
|
|
8
|
+
"MD033": false,
|
|
9
|
+
"MD036": false,
|
|
10
|
+
"MD041": true,
|
|
11
|
+
"MD046": { "style": "fenced" },
|
|
12
|
+
"MD049": { "style": "asterisk" },
|
|
13
|
+
"MD050": { "style": "asterisk" }
|
|
14
|
+
}
|