Skip to content

Commit 7aa36b1

Browse files
committed
Docs: marketing-polish README (hero, highlights, screenshots) + refresh USER_GUIDE (traceability/completeness, gates, skill pipelines)
1 parent ac14b07 commit 7aa36b1

4 files changed

Lines changed: 49 additions & 37 deletions

File tree

README.md

Lines changed: 30 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,36 @@
33
[![CI](https://github.com/hycomsa/moira/actions/workflows/ci.yml/badge.svg)](https://github.com/hycomsa/moira/actions/workflows/ci.yml)
44
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
55

6-
AI-native SDLC cockpit — governed orchestration layer **above** best-of-breed agent backends.
7-
8-
> **One repo.** This is the whole Moira product: `orchestrator/` (Python sidecar) +
9-
> `cockpit/` (React/TS) + `src-tauri/` (desktop shell). The AI SDLC framework content
10-
> (intents, requirements, specs, agents, skills) and any target application code live in
11-
> **separate** repositories that Moira reads/writes as a *workspace* — they are not part of
12-
> this repo.
13-
14-
Moira drives AI agents across the software development lifecycle (intent → requirements → design → code → QA → deploy) with human quality gates, git-native decision provenance, and model-agnostic execution. It does **not** re-implement an agent harness — it orchestrates pluggable frontier backends (Claude Code CLI, OpenAI Codex CLI, direct API) and adds the governance, traceability, and cockpit layer on top.
15-
16-
## Status: v0.1 (in development)
17-
18-
End-to-end on a real project (CSL Driver): shape specs via Discovery skills →
19-
guided/visual pipeline runs → human gates → tamper-evident git-native audit →
20-
report & traceability. **Built & verified (137 unit tests):**
21-
- `orchestrator/` — dependency-free DAG engine + gates (auto/hybrid/human/off) +
22-
pluggable backends (mock/claude_code/litellm) + audit with **tamper-evident
23-
hash chain** + pluggable persistence (**SQLite / PostgreSQL / git mirror**) +
24-
HTTP API. Drives AI SDLC **skills** for discovery (single + chained). Deterministic
25-
**AUTO_CHECK** gates: `ac_coverage` (every acceptance criterion has a task) and
26-
`test_exec` (the project's test suite actually passes) — escalate on a gap.
27-
- **Git-native task/epic backlog** (Zdzira-compatible — one markdown per ticket):
28-
`pm@decompose-func` turns a func-spec into an epic + tasks tagged by acceptance
29-
criterion; Moira measures **completeness** (Spec ↔ Tests ↔ Tasks ↔ Code) deterministically
30-
from the repo, alongside an optional **LLM conformance** scorecard. The same files
31-
open in [Zdzira PM](https://github.com/hycomsa) — one format, four tools.
32-
- `cockpit/` — React + TS + Vite cockpit: Overview (mission control + **delivery-health
33-
dashboard** — per-FUNC decomposed/tested/built/conformance), Runs (+ run metrics, report,
34-
**traceability badge & panel**, context orbit), **decision-ready** Inbox (coverage +
35-
conformance on every gate card), a modern pipeline editor, Discovery, Files, Traceability
36-
(list + graph + provenance orbit), reusable UI primitives, profile menu. Plus a **mobile**
37-
gate inbox (`/m`).
38-
- `src-tauri/` — Tauri v2 desktop shell (spawns the Python sidecar). Needs
39-
`cargo tauri` + webkit2gtk.
6+
AI-native SDLC cockpit — a **governed orchestration layer above** best-of-breed agent backends.
7+
8+
> ### The speed of AI. The calm of someone who has the proof.
9+
> Moira drives AI agents across the whole lifecycle — **intent → requirements → design → code → QA → deploy**
10+
> behind human quality gates, with a git-native, tamper-evident decision trail and model-agnostic execution.
11+
> It doesn't re-implement an agent harness; it **orchestrates** pluggable frontier backends (Claude Code CLI,
12+
> OpenAI Codex CLI, direct API) and adds the governance, traceability and cockpit layer on top.
13+
14+
**See it:** [marketing one-pager](docs/moira-landing.en.html) · **Run it:** [`USER_GUIDE.md`](USER_GUIDE.md) · **Build it:** [`CONTRIBUTING.md`](CONTRIBUTING.md)
15+
16+
![Delivery-health dashboard — every func-spec's decomposed / tested / built / conformance, at a glance](docs/assets/delivery-health.png)
17+
18+
## What Moira gives you
19+
20+
- **Governed gates** — auto / hybrid / human, with a **decision-ready Inbox**: every gate card shows AC-coverage + conformance, and a *failed* step shows the error with a one-click jump into the run.
21+
- **Git-native, tamper-evident audit** — every step and decision in a hash-chained trail; pluggable persistence (**SQLite / PostgreSQL / git mirror**).
22+
- **End-to-end traceability****Spec ↔ Tests ↔ Tasks ↔ Code** completeness, measured deterministically from the repo, plus an optional **LLM conformance** scorecard as a second opinion.
23+
- **Git-native task/epic backlog** — Zdzira-compatible, one markdown per ticket; `pm@decompose-func` turns a func-spec into an epic + tasks tagged by acceptance criterion. *One format, four tools.*
24+
- **Deterministic quality gates**`AUTO_CHECK` nodes: `ac_coverage` (every AC has a task) and `test_exec` (the test suite actually passes) — escalate to a human on a gap.
25+
- **Delivery-health dashboard** — per-FUNC decomposed / tested / built / conformance across the whole repo, in one view.
26+
- **Discovery (BA mode)** — drive AI SDLC skills to author intents / requirements / func-specs, gated at each step — as guided presets *or* as a real pipeline.
27+
- **Model-agnostic, anywhere** — Claude Code CLI · LiteLLM (frontier + local, anti-lock-in) · Codex CLI. **Desktop · web · mobile** (gate inbox at `/m`).
28+
29+
![Traceability panel — Spec ↔ Tests ↔ Tasks ↔ Code completeness + LLM conformance, per run](docs/assets/traceability-panel.png)
30+
31+
> **One repo.** This is the whole Moira product: `orchestrator/` (Python sidecar) + `cockpit/` (React/TS) +
32+
> `src-tauri/` (desktop shell). The AI SDLC framework content (intents, requirements, specs, agents, skills)
33+
> and any target application code live in **separate** repositories Moira reads/writes as a *workspace*.
34+
35+
**Status — v0.1 · 138 unit tests green · proven end-to-end on a real project (CSL Driver).**
4036

4137
## Getting started
4238

USER_GUIDE.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,9 @@ artifacts (intents, requirements, func-specs, ADRs) — gated, audited, git-nati
9595
- Reviewing in the Inbox, each gate shows a **📄 Authored** chip → click to read the
9696
produced artifact + its **provenance orbit**. Approve to continue the chain;
9797
reject to send feedback back and re-run that step.
98+
- **Discovery is a pipeline under the hood** — the chain compiles to an *author → gate* DAG on the same
99+
engine, so these authoring skills are also available on the **Pipelines** page (e.g. `sdlc-discovery`:
100+
*Intent → Requirements → Func-spec*, gated at each step) and editable like any pipeline.
98101

99102
## 6. SDLC runs — pipelines against a func-spec
100103

@@ -119,8 +122,11 @@ A modern node editor (your pipelines are YAML in the repo):
119122
- **Wire** — drag a node's right port → another's left port (dependencies);
120123
set a **reject → goto** rework edge; click an edge to delete.
121124
- **Node Settings (right)** — agent, **per-node model + backend override**
122-
(cross-model wiring), retries; for gates: segmented **mode** (auto/hybrid/
123-
human/off) + persona + confidence sliders; for auto-checks: the shell command.
125+
(cross-model wiring), retries, **per-node budget** (timeout / max-turns) for heavy steps;
126+
for gates: segmented **mode** (auto/hybrid/human/off) + persona + confidence sliders; for
127+
auto-checks: a shell command **or** a built-in check (`ac_coverage`, `test_exec`).
128+
- **Skill nodes** — a node can drive an AI SDLC **skill** (authoring), not just an agent. Authoring
129+
pipelines run against the AI SDLC repo; coding pipelines against the code repo.
124130
- **Run vs** picks the func-spec; **Save** writes the YAML; **▶ Run** launches it.
125131

126132
## 8. Gates & the Inbox ("Pending decisions")
@@ -129,11 +135,17 @@ Gates are checkpoints. Modes: **auto** (verifier verdict; HIGH/CRITICAL escalate
129135
**hybrid** (confidence-routed: high→accept, low→deny, middle→human) · **human**
130136
(a persona approves) · **off**. A waiting gate appears in the **Inbox** as a
131137
decision card showing:
138+
- a **decision-ready chip** — AC-coverage (`✓ AC 15/15` / `⚠ AC 3/15`) and the latest **⚖ LLM
139+
conformance** %, so you judge completeness before approving,
132140
- a **verdict banner** (✓ all checks green / ⚠ N checks failing),
133-
- the **checks feeding the gate** (verifier/auto-check results, failures in red),
141+
- the **checks feeding the gate** (verifier / `AUTO_CHECK` results — `ac_coverage` ensures every AC has a
142+
task, `test_exec` runs the test suite — failures in red),
134143
- **📄 Authored** artifacts (discovery) and **Proposed changes** (the file diff),
135144
- a **decision note** (recorded in the audit) + **Approve** / **Reject & rework**.
136145

146+
If a step **failed** (e.g. an agent timed out) the run escalates here: the card shows **why** (the
147+
timeout / retry / escalate events) and an **Open run →** link to the full execution plan.
148+
137149
**Client gate**: a business-language approval for a non-technical client (summary +
138150
requirements, never code). Tune hybrid thresholds under **Settings**.
139151

@@ -148,6 +160,10 @@ requirements, never code). Tune hybrid thresholds under **Settings**.
148160
targeted it, as a **List** or a **Graph**; click an artifact to read it. The
149161
**provenance orbit** (also in artifact views and run pre-flight) shows where an
150162
artifact came from / what's in the model's context.
163+
- **Completeness** — Moira measures **Spec ↔ Tests ↔ Tasks ↔ Code** per func-spec deterministically from
164+
the repo (ACs decomposed into tasks, ACs covered by a test plan, tasks done), shown as a badge + panel
165+
on the run and as a **delivery-health dashboard** on **Overview** (per-FUNC decomposed / tested / built).
166+
An optional **LLM conformance** scorecard (spec ↔ code) sits beside it as a second, qualitative signal.
151167

152168
## 10. Other pages
153169

docs/assets/delivery-health.png

51.9 KB
Loading

docs/assets/traceability-panel.png

175 KB
Loading

0 commit comments

Comments
 (0)