Skip to content

Commit 62702b3

Browse files
committed
feat: clarify workflow instructions and enhance the explanation of the 'needs bot review' flag in the README
1 parent ea24227 commit 62702b3

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Most AI tooling still reads like feature accumulation: a todo board here, a sche
2727
It connects three tightly linked layers:
2828

2929
1. Planning and triage in `Todo Cockpit`
30-
2. Execution and scheduling through `Tasks` and `Jobs`
31-
3. Tool and control-plane integration through `Research`, `MCP`, and optional agent surfaces
30+
2. Execution, scheduling, and performance improvement through `Tasks`, `Jobs`, and `Research`
31+
3. Tool and control-plane integration through `MCP` and optional agent surfaces
3232

33-
The workflow is explicit on purpose. A `Todo` is the planning artifact. A `Task` is one executable unit. A `Job` is an orchestrated or scheduled run built from steps. `Research` is an exploratory context-building artifact when the system still needs evidence before execution.
33+
The workflow is explicit on purpose. A `Todo` is the planning artifact — flag it **needs bot review** to trigger a focused investigation that returns findings as a comment. A `Task` is one executable unit. A `Job` is an orchestrated or scheduled run built from steps. `Research` is the performance and benchmarking workspace for iterative AI-driven improvement.
3434

3535
That structure keeps the LLM as the native execution chat surface while Copilot Cockpit provides the approval, scheduling, and control layer around it. The goal is not less automation. The goal is accountable automation that can move from intake to execution without losing review, context, or ownership.
3636

@@ -129,9 +129,9 @@ Think of `Jobs` as deeper agentic workflows inside VS Code: research, decision s
129129

130130
### Research
131131

132-
`Research` is the exploratory context-building layer. Use it when the system is missing context, needs outside evidence, or should iterate against a benchmark before you decide on execution.
132+
`Research` is the performance and benchmarking workspace. Use it to harvest better performance through AI-driven code changes, iterate against measurable goals, and track improvement over time.
133133

134-
Research is especially useful when work should pull in fresher outside knowledge first, through web search, Perplexity, scrapers, or other tooling, and then return that material for user review before implementation begins.
134+
The **needs bot review** flag on a Todo is a separate, lighter mechanism: flag a Todo for investigation, the agent returns findings as a comment on the card, and you decide what to do next — without launching a full Research session.
135135

136136
### Experimental and advanced playground capabilities
137137

@@ -153,7 +153,7 @@ That also creates a control layer for cost: GitHub Copilot or OpenRouter can use
153153

154154
### How To Use
155155

156-
`How To Use` is the built-in onboarding tab. Start there if you want the recommended path explained in order: `Todo` first, `Research` when context is missing, `Task` or `Job` for execution, then optional control-plane integration after the core loop is working.
156+
`How To Use` is the built-in onboarding tab. Start there if you want the recommended path explained in order: `Todo` first, flag **needs bot review** for investigation, `Task` or `Job` for execution, `Research` for performance benchmarking, then optional control-plane integration after the core loop is working.
157157

158158
## Common Workflows
159159

@@ -163,7 +163,7 @@ Capture work in `Todo Cockpit`, discuss it, move it into `ready`, and only then
163163

164164
### Research-First Collaboration
165165

166-
Use `Research`, web search, or tool-assisted discovery to gather current information first. Review that output with the user, discuss changes, and only then convert the result into scheduled implementation work.
166+
Flag a Todo **needs bot review** to launch a focused investigation. The agent researches the issue and returns findings as a comment. Review that output with the user, discuss changes, and only then convert the result into scheduled implementation work.
167167

168168
### Scheduled Execution
169169

@@ -193,9 +193,9 @@ Start with one recurring loop that produces useful work instead of toy output.
193193
- `Delivery Risk and Security Watch (Daily)` looks for shipping, trust, and operational blind spots.
194194
- `Knowledge and Shipping Packager (Daily)` stages reusable docs, memory candidates, and release material for later curation.
195195
- `Project Intelligence and Delivery Prep` runs those steps in sequence and stops at a review checkpoint before anything turns into real execution.
196-
- `Onboarding Example Coverage Research` starts with a Todo Cockpit intake item, uses Research to gather or benchmark onboarding evidence, and then promotes approved follow-up into Tasks or Jobs.
196+
- `Onboarding Example Coverage Research` starts with a Todo Cockpit intake item, uses the **needs bot review** flow to investigate onboarding gaps, and then promotes approved follow-up into Tasks or Jobs.
197197

198-
Use that onboarding example when you want one concrete loop to demonstrate the product: start in Todo Cockpit, gather context with Research, promote approved work into Tasks or Jobs, and stop at a review checkpoint before autonomy expands.
198+
Use that onboarding example when you want one concrete loop to demonstrate the product: start in Todo Cockpit, flag **needs bot review** to investigate, promote approved work into Tasks or Jobs, and stop at a review checkpoint before autonomy expands.
199199

200200
This is a good fit for a solo product, an internal tool, a small SaaS, or an actively maintained extension like this repo.
201201

@@ -214,13 +214,13 @@ The point is not to overclaim autonomy. The point is to show recurring, inspecta
214214
1. Open Copilot Cockpit from the activity bar or run `Copilot Cockpit: Create Scheduled Prompt (GUI)` from the command palette. Or use the todo-list icon in the top right.
215215
2. Start in `How To Use` if you are new to the extension, or click the top-bar `Intro Tutorial` button for the same guided walkthrough.
216216
3. Capture or refine work in `Todo Cockpit` until the planning artifact is clear.
217-
4. Use `Research` if the work still needs exploratory context or outside evidence.
217+
4. Flag the Todo **needs bot review** if the work needs investigation before execution.
218218
5. Move approved work into `ready`, then promote it into a `Task` for one executable unit or a `Job` for an orchestrated run.
219219
6. Open `Settings` to configure repo-local defaults and optional integrations such as the GitHub inbox flow. Add `MCP`, Copilot skills, starter agents, or other control-plane features only when you want those optional extensions.
220220

221221
If you want the optional integration layers, the practical order is:
222222

223-
1. Get the core `Todo` -> `Research` -> `Task` or `Job` loop working first.
223+
1. Get the core `Todo` -> flag **needs bot review** -> `Task` or `Job` loop working first.
224224
2. Use `Set Up MCP` to create or repair `.vscode/mcp.json` and activate the repo-local scheduler MCP server for this workspace.
225225
3. Add any separate third-party MCP servers you want, such as Tavily, Perplexity, or [Prefab by Max Health Inc.](https://github.com/Max-Health-Inc/prefab), to that same workspace MCP config. Those servers are separate from Copilot Cockpit's scheduler server and may need their own API keys or provider-specific setup.
226226
4. Use `Sync Bundled Skills` to write the bundled Copilot skills into `.github/skills` once you want stronger repo-local guidance for how Copilot should approach work. If the Prefab by Max Health Inc. MCP server is configured, that bundled path also adds the `prefab-ui` skill so installed users can route Prefab by Max Health Inc. UI and wire-format work through the shipped contract instead of keeping it as a repo-only extra.

0 commit comments

Comments
 (0)