Skip to content

Commit 98b59e1

Browse files
committed
specs: Consolidate AGENTS.md into a single file
1 parent 89b67e5 commit 98b59e1

File tree

3 files changed

+20
-21
lines changed

3 files changed

+20
-21
lines changed

.obsidian/workspace.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
"state": {
1414
"type": "markdown",
1515
"state": {
16-
"file": "specs/Public/CLI.md",
16+
"file": "specs/AGENTS.md",
1717
"mode": "source",
1818
"source": false
1919
},
2020
"icon": "lucide-file",
21-
"title": "CLI"
21+
"title": "AGENTS"
2222
}
2323
},
2424
{
@@ -194,10 +194,12 @@
194194
},
195195
"active": "01bf72509d2b5652",
196196
"lastOpenFiles": [
197+
"docs/marketing-one-pager.md",
197198
"specs/AGENTS.md",
199+
"specs/Public/AGENTS.md",
200+
"specs/Public/CLI.md",
198201
"scripts/md-mermaid-validate.sh",
199202
"specs/Public/Configuration.md",
200-
"specs/Public/CLI.md",
201203
"specs/Public/3rd-Party Agents/3rd-Party Agent Description Template.md",
202204
"specs/Public/Nix Devcontainer/Devcontainer User Setup.md",
203205
"specs/Public/Nix Devcontainer/Devcontainer Design.md",
@@ -208,7 +210,6 @@
208210
"specs/Public/Browser Automation/Codex.md",
209211
"specs/Public/Extras Framework.md",
210212
"specs/Public/Lima VM Images.md",
211-
"specs/Public/AGENTS.md",
212213
"specs/Public/Agent Time Travel.md",
213214
"specs/Public/WebUI PRD.md",
214215
"specs/Public/TUI PRD.md",
@@ -225,7 +226,6 @@
225226
"test/logs/temp_output_20250828_001209.log",
226227
"test/temp_test_runner_1756329129.rb",
227228
"test/logs/test_run_20250828_001209.log",
228-
"specs/Initial Developer Input/Configuration.md",
229229
"specs/Initial Developer Input",
230230
"specs/Research"
231231
]

specs/AGENTS.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
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.
116
# Specs Maintenance
217

318
- Before committing any change to the `specs/` folder, run `just lint-specs` from the project root. This performs Markdown linting, link checking, spell checking, prose/style linting, and Mermaid diagram validation.
4-
- The Nix dev shell is fully reproducible; if a required tool is missing inside the shell, fix `flake.nix` rather than using ad‑hoc fallbacks.
519

620
If the pre-commit hook blocks your commit, run `just lint-specs`, address the reported issues, and commit again.

specs/Public/AGENTS.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

0 commit comments

Comments
 (0)