feat: make docs output path configurable via user settings

Abierto
#338 10 comentarios 10 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
42/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
tooling

Línea de trabajo

Start by tracing how generated brainstorms, plans, solutions, and specs read and write paths under docs/, then look for existing configurable path settings in the TypeScript plugin. Identify the shared entry points and tests that cover those paths before estimating the change. Done means a global or project-level docsPath setting redirects all generated document reads and writes while preserving the default behavior.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Problem

Projects that already use docs/ for their own documentation (specs, API docs, etc.) experience path conflicts when compound-engineering auto-generates and references files under the same docs/ directory. This creates ambiguity about what is project-owned vs plugin-generated content.

Proposal

Allow users to configure the output path for plugin-generated documents (brainstorms, plans, solutions, specs) via a global or project-level setting — similar to how other paths are already configurable.

Example:

{
  "compound-engineering": {
    "docsPath": ".compound/docs"
  }
}

This would redirect all auto-generated reads/writes from docs/ to the configured path.

Why it matters

  • docs/ is a widely used convention (VitePress, Docusaurus, API docs, etc.)
  • Mixing project docs with plugin-generated artifacts makes both harder to navigate
  • A simple path override keeps the default ergonomic while unblocking projects that need separation
Lenguaje dominante
TypeScript
Estrellas
25.6k
Forks
2.1k
Merge medio
3 h 57 min
PR fusionados (30 d)
170

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de EveryInc/compound-engineering-plugin

Todos los issues de EveryInc/compound-engineering-plugin

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.