feat: make docs output path configurable via user settings

Open
#338 10 comments 10 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
tooling

Research direction

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.

Written by the indexing model from the issue text.

Description

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
Dominant language
TypeScript
Stars
25.6k
Forks
2.1k
Avg merge
3h 57m
Merged PRs (30d)
170

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EveryInc/compound-engineering-plugin

All issues in EveryInc/compound-engineering-plugin

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.