Skip to content

Commit 9a1378f

Browse files
committed
specs: New repository structure with additional instructions and new TODO items
1 parent fbd4442 commit 9a1378f

39 files changed

+198
-115
lines changed

.agents/codebase-insights.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,10 @@
3939
## Config Mapping Notes
4040
- TOML preserves dashes in keys (e.g., `network.api-url`, `tui.default-mode`, `repo.task-runner`).
4141
- ENV/JSON use underscores for those keys (e.g., `AGENTS_WORKFLOW_NETWORK_API_URL`). See specs/configuration.md.
42+
43+
## 2025-08-28 — Spec TODOs addressed
44+
- Added `ui.default` config key (schema + docs) to control whether bare `aw` launches TUI or WebUI (default: `tui`).
45+
- Fixed CLI config mapping examples to follow mechanical rules (camelCase in nested keys like `apiUrl`, `chatgptUsername`).
46+
- Clarified snapshot selection semantics in CLI spec: strategy is chosen by the executing host; leader-only snapshots in fleets.
47+
- Expanded `sandbox-profiles` with motivations, predefined types, and OS guidance.
48+
- WebUI tech note now picks React + Vite + TypeScript as the non-binding default.

.obsidian/workspace.json

Lines changed: 38 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
"state": {
1414
"type": "markdown",
1515
"state": {
16-
"file": "specs/AGENTS.md",
16+
"file": "specs/Public/3rd-Party Agents/3rd-Party Agent Description Template.md",
1717
"mode": "source",
1818
"source": false
1919
},
2020
"icon": "lucide-file",
21-
"title": "AGENTS"
21+
"title": "3rd-Party Agent Description Template"
2222
}
2323
},
2424
{
@@ -27,7 +27,7 @@
2727
"state": {
2828
"type": "markdown",
2929
"state": {
30-
"file": "specs/fs-snapshots/overview.md",
30+
"file": "specs/Public/FS Snapshots/FS Snapshots Overview.md",
3131
"mode": "source",
3232
"source": false,
3333
"backlinks": true,
@@ -42,7 +42,7 @@
4242
}
4343
},
4444
"icon": "lucide-file",
45-
"title": "overview"
45+
"title": "FS Snapshots Overview"
4646
}
4747
}
4848
]
@@ -102,7 +102,7 @@
102102
}
103103
],
104104
"direction": "horizontal",
105-
"width": 300
105+
"width": 384.5
106106
},
107107
"right": {
108108
"id": "6bab4bb451c2c34d",
@@ -194,33 +194,38 @@
194194
},
195195
"active": "01bf72509d2b5652",
196196
"lastOpenFiles": [
197-
"specs/agent-time-travel.md",
198-
"specs/AGENTS.md",
199-
"specs/cli-spec.md",
200-
"specs/@initial-developer-input/Configuration.md",
201-
"specs/@initial-developer-input/WebUI, TUI, REST Service.md",
202-
"specs/@initial-developer-input",
203-
"specs/local-mode.md",
204-
"specs/fs-snapshots/overview.md",
205-
"specs/fs-snapshots/milestone_5.md",
206-
"specs/fs-snapshots/milestone_4.md",
207-
"specs/fs-snapshots/milestone_3.md",
208-
"specs/fs-snapshots/milestone_2.md",
209-
"specs/fs-snapshots/milestone_1.md",
210-
"specs/webui-prd.md",
211-
"specs/tui-prd.md",
212-
"specs/rest-service.md",
213-
"specs/sandbox-profiles.md",
214-
"specs/remote-mode.md",
215-
"specs/prompt-engineering.md",
216-
"specs/multi-os-testing.md",
217-
"specs/lima-vm-images.md",
218-
"specs/extras-framework.md",
219-
"specs/devcontainer-setup.md",
220-
"specs/devcontainer-design.md",
221-
"specs/connectivity-layer.md",
222-
"specs/configuration.md",
223-
"specs/schemas/AGENTS.md",
224-
"specs/@research"
197+
"specs/Public/Nix Devcontainer/Devcontainer User Setup.md",
198+
"specs/Public/Nix Devcontainer/Devcontainer Design.md",
199+
"specs/Public/Nix Devcontainer/Devcontainer Test Suite.md",
200+
"specs/Public/Nix Devcontainer/Devcontainer Cache Guidelines.md",
201+
"specs/Public/FS Snapshots/FS Snapshots Overview.md",
202+
"specs/Public/Agent Browsers/Agent Browser Profiles.md",
203+
"specs/Public/Browser Automation/Codex.md",
204+
"specs/Public/Extras Framework.md",
205+
"specs/Public/Lima VM Images.md",
206+
"specs/Public/AGENTS.md",
207+
"specs/Public/Agent Time Travel.md",
208+
"specs/Public/Configuration.md",
209+
"specs/Public/CLI.md",
210+
"specs/Public/WebUI PRD.md",
211+
"specs/Public/TUI PRD.md",
212+
"specs/Initial Developer Input/WebUI, TUI, REST Service.md",
213+
"specs/Public",
214+
"specs/Public/Connectivity Layer.md",
215+
"specs/Public/Prompt Engineering.md",
216+
"specs/Public/REST Service.md",
217+
"specs/Public/Sandbox Profiles.md",
218+
"specs/Public/Multi-OS Testing.md",
219+
"specs/Public/Remote Mode.md",
220+
"specs/Public/Local Mode.md",
221+
"agent-task-0.1.0.gem",
222+
"test/logs/temp_output_20250828_001209.log",
223+
"test/temp_test_runner_1756329129.rb",
224+
"test/logs/test_run_20250828_001209.log",
225+
"specs/Initial Developer Input/Configuration.md",
226+
"specs/Initial Developer Input",
227+
"specs/Public/FS Snapshots/milestone_5.md",
228+
"specs/Public/FS Snapshots/milestone_4.md",
229+
"specs/Research"
225230
]
226231
}

specs/AGENTS.md

Lines changed: 0 additions & 7 deletions
This file was deleted.
File renamed without changes.

specs/@initial-developer-input/WebUI, TUI, REST Service.md renamed to specs/Initial Developer Input/WebUI, TUI, REST Service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
I'd like to write few more specs in the docs folder. Before we start please read the existing docs.
22

3-
1) It will be possible to launch agents-workflow as a REST service. The service will be able to spawn tasks on demand and list currently active coding sessions (as explained in [fs-snapshots-overview](../fs-snapshots/overview.md)). We need a document describing the purpose of this service and its specification. It's intended for usage by companies that set up on-premise or private cloud clusters for running coding tasks or for developers who prefer a WebUI experience.
3+
1) It will be possible to launch agents-workflow as a REST service. The service will be able to spawn tasks on demand and list currently active coding sessions (as explained in [fs-snapshots-overview](../Public/FS%20Snapshots/FS%20Snapshots%20Overview.md)). We need a document describing the purpose of this service and its specification. It's intended for usage by companies that set up on-premise or private cloud clusters for running coding tasks or for developers who prefer a WebUI experience.
44

55
2) There will be a WebUI front-end that will consume the REST service. It needs something like PRD document and detailed spec of its UI.
66

File renamed without changes.

specs/Public/AGENTS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
This folder contains a work-in-progress specification for the next iteration of the agents-workflow product.
2+
3+
The main ideas of the product are described in the [marketing-one-pager](../../docs/marketing-one-pager.md) document. Please read it.
4+
5+
Currently, the spec is not finalized and we are not ready to start the implementation of the software. The folder `specs/Initial Developer Input` contains files that should be treated as a ground truth for the specification effort. You are expected to work on the markdown files in the `specs/Public` folder, which should detail everything with a much higher precision, but please note that not all information in them has been fully reviewed by the development team yet.
6+
7+
Files in the public folder should never refer to documents in the `specs/Initial Developer Input` folder or the `specs/Research` folder, where we put preliminary-research findings that also haven't been fully vetted.
8+
9+
Your goal is to build a very comprehensive specification, meeting the goals stated in the initial developer input and expanding upon them with solid research and engineering. You may use the information provided in the preliminary research findings, but please verify it, potentially by building a small PoC programs.
10+
11+
The public spec should be a stand-alone document that never references other folders. In other words, your job is to transform the content from the other folders into a high-quality spec.
12+
13+
For each file in the `spec/Public` folder, there will be a corresponding file in the `spec/Implementation Progress` folder. This is a place to store information regarding what was already prototyped or implemented for production use. The files in this folder should contain references to source code files that are a good starting point for someone who wants to see the code behind the spec.
14+
15+
Some of the markdown files have standardized Obsidian headers indicating their current review status. Avoid modifying files with status "Reviewed" or "Final" unless explicitly asked.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)