Enhancement: Add project scaffolding for docs/solutions/ schema + agentic feedback loops

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
github, typescript, yaml

调研方向

Start by reading skills/compound-docs/references/yaml-schema.md and tracing the /workflows:compound and /report-bug command definitions. The issue proposes scaffolding, schema validation, and feedback submission as separate changes; determine their scope and expected behavior with maintainers before implementation. Done would include agreed behavior for the setup and feedback flows, with validation against the documented schema.

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

描述

enhancement
Enhancement: Add project scaffolding for docs/solutions/ schema + agentic feedback loops

Labels

enhancement, documentation


Body

## Summary
 
First-time use of `/workflows:compound` on a Shopify/Node.js project revealed a bootstrapping gap that undermines the knowledge compounding system.
 
**The core issue**: The plugin has a well-defined YAML schema (`skills/compound-docs/references/yaml-schema.md`) with specific enum values for `problem_type`, `component`, `root_cause`, etc. But this schema is never communicated to new projects, so:
 
1. First compound run may create docs with different/inconsistent frontmatter
2. Future `learnings-researcher` queries can't find them (expects exact enum matches)
3. Knowledge doesn't actually compound
 
## What Happened
 
When `/workflows:compound` ran for the first time, the agents created docs in `docs/solutions/` with YAML frontmatter. But the receiving project had:
 
- No `docs/solutions/README.md` explaining the expected structure
- No knowledge of the schema the agents expect
- No way to validate the frontmatter is correct
- No guarantee future compound runs will find past solutions
 
## Suggested Improvements
 
### 1. Add `/compound:init` command (Short-term)
 
A one-time setup that:
- Creates `docs/solutions/README.md` with the schema definition
- Creates category subdirectories matching `problem_type` enums
- Optionally creates `docs/solutions/.schema.yaml` for validation
 
### 2. Make `/workflows:compound` check for scaffolding (Medium-term)
 
Before creating documentation:
- If `docs/solutions/README.md` doesn't exist, auto-scaffold or prompt user
- Validate generated frontmatter against schema before writing
 
### 3. Add agentic feedback loops (Long-term)
 
**The meta-problem**: When an agent discovers issues while using the plugin, there's no standardized way to submit feedback agentically.
 
Suggestion: Add `/compound:feedback` command that:
- Captures context automatically (plugin version, command used, what happened)
- Formats feedback according to maintainer preferences
- Submits via GitHub issue
 
This creates a virtuous cycle:

Agent uses plugin → Discovers issue → Submits feedback → Plugin improves → Better agent experience

 
**This issue itself is an example** - an agent (Claude) discovered these gaps but had no agentic way to submit them. The user had to manually identify the correct repo.
 
## Bug Found
 
The installed plugin's `/report-bug` command (v2.27.0) targets:

kieranklaassen/every-marketplace

 
But the actual public repo is:

EveryInc/compound-engineering-plugin

 
## Related Issues
 
- #95 (pre-compact knowledge capture) - shares the "auto-capture before context loss" philosophy
- #79 (docs discoverability) - same theme of hidden resources
 
## Environment
 
- **Plugin Version**: 2.27.0
- **Project Type**: Shopify Liquid + Node.js
- **First-time compound user**: Yes
 
## Impact
 
Without this fix:
- First-time users create docs with inconsistent schemas
- Knowledge doesn't compound across runs
- `learnings-researcher` can't effectively find past solutions
- The core value prop ("each unit of work makes future work easier") is undermined
 
---
 
*Feedback discovered and documented by Claude agent during first `/workflows:compound` use*

主要语言
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 摘要。