feat: make docs output path configurable via user settings

未关闭
#338 10 条评论 10 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
42/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
typescript
领域
tooling

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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
主要语言
TypeScript
星标
25.6k
派生
2.1k
平均合并
3 小时 57 分钟
30 天内合并 PR
170

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

EveryInc/compound-engineering-plugin 的其他 Issue

查看 EveryInc/compound-engineering-plugin 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。