feat: make docs output path configurable via user settings

オープン
#338 コメント 10 件 リアクション 10 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR(30日)
170

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

EveryInc/compound-engineering-plugin のほかの issue

EveryInc/compound-engineering-plugin の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。