Skip to content

Commit fb22f39

Browse files
author
Akkari
committed
docs: fix 7 broken links, update stale critic counts, bump to v0.7.2
- Fixed 7 broken relative links from docs restructure (CONFIG_REFERENCE, SPEC, CONTRIBUTING, reference-implementation paths) - SKILL.md: '4 independent AI critics' → '6' (matches 6 shipped critics) - README.md: version badge v0.7.0 → v0.7.2 - Version bump in critic-status.yaml + pyproject.toml - CHANGELOG v0.7.2 entry added
1 parent 681a288 commit fb22f39

10 files changed

Lines changed: 35 additions & 12 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<p align="center">
66
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-2ba4c8.svg" alt="MIT License"></a>
77
<img src="https://img.shields.io/badge/platform-OpenClaw-2ba4c8" alt="Platform: OpenClaw">
8-
<img src="https://img.shields.io/badge/status-v0.7.0-2ba4c8" alt="Status: v0.7.0">
8+
<img src="https://img.shields.io/badge/status-v0.7.2-2ba4c8" alt="Status: v0.7.2">
99
<a href="https://clawhub.ai/dacervera/quorum"><img src="https://img.shields.io/badge/ClawHub-dacervera%2Fquorum-2ba4c8" alt="Available on ClawHub"></a>
1010
</p>
1111

SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: quorum
3-
description: Multi-agent validation framework — 4 independent AI critics evaluate artifacts against rubrics with evidence-grounded findings.
3+
description: Multi-agent validation framework — 6 independent AI critics evaluate artifacts against rubrics with evidence-grounded findings.
44
metadata: {"openclaw":{"requires":{"bins":["python3","pip"],"env":["ANTHROPIC_API_KEY","OPENAI_API_KEY"]},"install":[{"id":"clone-repo","kind":"shell","command":"git clone https://github.com/SharedIntellect/quorum.git /tmp/quorum-install && cd /tmp/quorum-install/reference-implementation && pip install -r requirements.txt","label":"Clone Quorum repo and install Python dependencies"}],"source":"https://github.com/SharedIntellect/quorum"}}
55
---
66

critic-status.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Used by tools/validate-docs.py to detect stale documentation.
33
# Update this file FIRST when shipping a critic or feature.
44

5-
version: "0.7.0"
5+
version: "0.7.2"
66
spec_version: "3.0"
77

88
critics:

docs/CHANGELOG.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,29 @@ All notable changes to Quorum will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
66

7+
## [0.7.2] — 2026-03-12
8+
9+
### Documentation — Docs Restructure & README Rewrite (PR #16)
10+
11+
- **README.md** rewritten: ~400 lines → ~120 lines. Focused on what Quorum is, how to run it, and where to go next. First-person voice preserved.
12+
- **23 docs reorganized** into 6 categorized subdirectories under `docs/`:
13+
- `getting-started/` — QUICK_START, INSTALLATION, TUTORIAL, FOR_BEGINNERS, MODEL_REQUIREMENTS
14+
- `architecture/` — IMPLEMENTATION, THE_NINE
15+
- `critics/` — all critic-specific docs and frameworks
16+
- `guides/` — RUBRIC_BUILDING_GUIDE, CROSS_ARTIFACT_DESIGN
17+
- `reviews/` — external review snapshots
18+
- `configuration/` — CONFIG_REFERENCE
19+
- **New files:** `docs/getting-started/QUICK_START.md` (zero to running in <5 min), `docs/README.md` (navigation hub)
20+
- All cross-references updated across 30+ files
21+
- `validate-docs.py` exclusion updated to match new `docs/reviews/` path
22+
23+
### Fixed
24+
- 7 broken relative links caused by docs moving one directory deeper (CONFIG_REFERENCE, SPEC, CONTRIBUTING, reference-implementation paths)
25+
- `SKILL.md` frontmatter: "4 independent AI critics" → "6" (matched shipped state)
26+
- `README.md` version badge: v0.7.0 → v0.7.2
27+
28+
---
29+
730
## [0.7.1] — 2026-03-12
831

932
### Fixed — Self-Validation Findings (PR #14)

docs/architecture/THE_NINE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ That's why there are nine.
180180

181181
---
182182

183-
*The characters in this story correspond to the nine agents defined in the [Quorum Specification](../SPEC.md). Their behaviors, evidence requirements, and interaction patterns are real. The drama is only slightly exaggerated.*
183+
*The characters in this story correspond to the nine agents defined in the [Quorum Specification](../../SPEC.md). Their behaviors, evidence requirements, and interaction patterns are real. The drama is only slightly exaggerated.*
184184

185185
---
186186

docs/getting-started/FOR_BEGINNERS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ That's it. No build step. No configuration files to wrestle with. No Docker cont
6666

6767
## "But where's the code?"
6868

69-
Right here: [`reference-implementation/`](../reference-implementation/)
69+
Right here: [`reference-implementation/`](../../reference-implementation/)
7070

7171
```bash
7272
cd reference-implementation

docs/getting-started/INSTALLATION.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ models:
5555
depth: standard # quick | standard | thorough
5656
```
5757
58-
See [CONFIG_REFERENCE.md](CONFIG_REFERENCE.md) for full options and [MODEL_REQUIREMENTS.md](MODEL_REQUIREMENTS.md) for supported models.
58+
See [CONFIG_REFERENCE.md](../configuration/CONFIG_REFERENCE.md) for full options and [MODEL_REQUIREMENTS.md](MODEL_REQUIREMENTS.md) for supported models.
5959
6060
## Requirements
6161
@@ -66,7 +66,7 @@ See [CONFIG_REFERENCE.md](CONFIG_REFERENCE.md) for full options and [MODEL_REQUI
6666

6767
## Troubleshooting
6868

69-
**"No model configured"** — Run `quorum run` once and follow the first-run setup prompts, or manually create `quorum-config.yaml` (see [CONFIG_REFERENCE.md](CONFIG_REFERENCE.md)).
69+
**"No model configured"** — Run `quorum run` once and follow the first-run setup prompts, or manually create `quorum-config.yaml` (see [CONFIG_REFERENCE.md](../configuration/CONFIG_REFERENCE.md)).
7070

7171
**"API key not found"** — Set your provider's API key as an environment variable:
7272
```bash

docs/getting-started/MODEL_REQUIREMENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Quorum's critics need models that can reason about complex artifacts, follow str
44

55
## Tier System
66

7-
Quorum uses a two-tier architecture. **Tier 1** handles judgment-heavy roles (supervisor, aggregator, security critic). **Tier 2** handles pattern-matching roles (correctness, completeness, architecture critics). See [CONFIG_REFERENCE.md](CONFIG_REFERENCE.md) for which roles map to which tier.
7+
Quorum uses a two-tier architecture. **Tier 1** handles judgment-heavy roles (supervisor, aggregator, security critic). **Tier 2** handles pattern-matching roles (correctness, completeness, architecture critics). See [CONFIG_REFERENCE.md](../configuration/CONFIG_REFERENCE.md) for which roles map to which tier.
88

99
### Tier 1 — Recommended (Judgment Roles)
1010

@@ -49,7 +49,7 @@ models:
4949
tier_2: anthropic/claude-sonnet-4-6 # Evaluation roles (correctness, completeness, architecture)
5050
```
5151
52-
For per-critic overrides, see [CONFIG_REFERENCE.md](CONFIG_REFERENCE.md).
52+
For per-critic overrides, see [CONFIG_REFERENCE.md](../configuration/CONFIG_REFERENCE.md).
5353
5454
**First-run behavior:** If no config exists, Quorum auto-detects your available model, asks two setup questions (preferred tier 1 and tier 2 models), writes the config, and proceeds immediately. Zero-config users get sensible defaults.
5555

docs/guides/RUBRIC_BUILDING_GUIDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Before you start, you need:
2323
1. **The source document in parseable format.** PDFs with embedded text work fine; scanned PDFs need OCR. See Step 1.
2424
2. **Domain knowledge.** This is non-negotiable. Standards are dense, and normative decomposition without domain knowledge produces rubrics that are technically correct and practically useless. The criteria generation step (Step 3) is where expertise matters most.
2525
3. **A clear scope boundary.** Full standards are large. Decide upfront which sections or requirement types you're encoding. Scope creep kills rubric projects.
26-
4. **The Quorum rubric schema.** See [CONFIG_REFERENCE.md](CONFIG_REFERENCE.md) for the full spec. A rubric is a JSON file; critics consume it at evaluation time.
26+
4. **The Quorum rubric schema.** See [CONFIG_REFERENCE.md](../configuration/CONFIG_REFERENCE.md) for the full spec. A rubric is a JSON file; critics consume it at evaluation time.
2727

2828
---
2929

@@ -353,4 +353,4 @@ These assume focused work, good source quality, and pre-existing domain expertis
353353

354354
---
355355

356-
*Questions or rubric contributions → [CONTRIBUTING.md](../CONTRIBUTING.md)*
356+
*Questions or rubric contributions → [CONTRIBUTING.md](../../CONTRIBUTING.md)*

reference-implementation/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "quorum-validator"
7-
version = "0.7.0"
7+
version = "0.7.2"
88
description = "Multi-critic quality validation for agents, research, and configurations"
99
authors = [
1010
{name = "Daniel Cervera", email = "daniel@sharedintellect.com"},

0 commit comments

Comments
 (0)