Skip to content

Commit f8027a5

Browse files
committed
Restructure and update design specs; add messaging update proposal and index file
1 parent a3fa809 commit f8027a5

7 files changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Foreman uses a YAML configuration file to define repositories, agents, and LLM b
6262
```
6363

6464
For detailed configuration options, see [config.example.yaml](config.example.yaml)
65-
and the [Project Specification](docs/specs/initial/SPEC.md).
65+
and the [Project Specification](docs/specs/01-agent-harness/SPEC.md).
6666

6767
## Project Structure
6868

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Messaging update
2+
3+
## Problem Statement
4+
5+
The current wire protocol doesn't handle the case where a message is sent to a node that is not connected.
6+
This leads to missed events with no way to recover.

docs/specs/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Design Specifications
2+
3+
This directory contains design specifications and architectural proposals for the Foreman project.
4+
5+
## Table of Contents
6+
7+
### [01-agent-harness](./01-agent-harness/SPEC.md)
8+
9+
The core specification for the Foreman project.
10+
11+
- **Objective**: Build a minimal Python harness for always-on AI co-maintainers that handles process lifecycle,
12+
credential injection, and message routing.
13+
- **Key Documents**:
14+
- [Specification](./01-agent-harness/SPEC.md): Technical details and requirements.
15+
- [Idea](./01-agent-harness/idea.md): Problem statement and recommended direction.
16+
- [Plan](./01-agent-harness/plan.md): Implementation roadmap.
17+
- [Todo](./01-agent-harness/todo.md): Tracked tasks.
18+
19+
### [02-messaging-update](./02-messaging-update/idea.md)
20+
21+
A proposal for improving the messaging system.
22+
23+
- **Objective**: Address the issue where messages sent to disconnected nodes are lost.
24+
- **Key Documents**:
25+
- [Idea](./02-messaging-update/idea.md): Problem statement regarding the wire protocol and recovery mechanisms.

0 commit comments

Comments
 (0)