Skip to content

Commit 500e07b

Browse files
committed
chore(docs): repo-wide doc tidy + .machine_readable canonical layout
Root-level reconciliation: - Move dated session reports to docs/archive/ (BOT-ENHANCEMENTS, DOGFOODING-ANALYSIS, FLEET-DEPLOYMENT-STATUS, NEW-PATTERNS-DEPLOYMENT, OUTSTANDING-WORK) with a docs/archive/README.md index recording why each one is kept. - Move long-form BOT-OPERATIONS.md under docs/. - Drop near-duplicate llm-warmup-{dev,user}.md stubs (16-line identical copies); the same information is in README.adoc + EXPLAINME.adoc. - Rewrite README.adoc: remove duplicate "== Architecture" section, expand bot table to all 11 bots, point at docs/ARCHITECTURE.md as the single source of truth, add a Documentation section listing the authoritative pointers. - Add docs/README.md as the docs index. .machine_readable/ taxonomy fix per A2ML-REPO-TEMPLATE (hyperpolymath/standards): - Flatten .machine_readable/6a2/*.a2ml up to .machine_readable/*.a2ml (AGENTIC, ECOSYSTEM, META, NEUROSYM, PLAYBOOK, STATE). - Flatten .machine_readable/anchors/ANCHOR.a2ml up to .machine_readable/ANCHOR.a2ml. - The seven canonical files now sit directly under .machine_readable/ exactly as the template specifies. Add docs/ARCHITECTURE.md as the single source of truth for the pipeline, components, and critical invariants. The repo-root README.adoc + .claude/CLAUDE.md both link here. Refresh .claude/CLAUDE.md: drop the stale ".machine_readable/6scm/" invariant and point at the new docs/ARCHITECTURE.md + docs/archive/ locations. Add docs/wiki-source/ with Markdown for the GitHub wiki (Home, Architecture, Safety-Triangle, Build-and-Run, Bot-Operations, plus _Sidebar and _Footer). The repo is the source of truth; the wiki is a publication target — docs/README.md documents the sync command.
1 parent 9d08064 commit 500e07b

27 files changed

Lines changed: 529 additions & 127 deletions

.claude/CLAUDE.md

Lines changed: 41 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
11
# SPDX-License-Identifier: PMPL-1.0-or-later
22

3-
# CLAUDE.md - Gitbot Fleet
3+
# CLAUDE.md Gitbot Fleet
44

55
## Project Overview
66

7-
Gitbot Fleet is the bot orchestration hub for automated repository quality enforcement across 500+ hyperpolymath repositories. It coordinates multiple bots through a shared-context system with safety-triangle-aware routing.
7+
Gitbot Fleet is the bot orchestration hub for automated repository
8+
quality enforcement across ~500 hyperpolymath repositories. It
9+
coordinates 11 bots through a shared-context system with safety-triangle
10+
-aware routing.
811

9-
## Architecture
12+
The authoritative architecture document is [`docs/ARCHITECTURE.md`](../docs/ARCHITECTURE.md).
13+
The repo-root `README.adoc` is the entry point for humans.
14+
15+
## Architecture (summary — see `docs/ARCHITECTURE.md` for the full pipeline)
1016

1117
```
1218
hypatia (scanner) → findings JSONL → fleet-coordinator.sh → dispatch-runner.sh
13-
19+
1420
┌──────────┼──────────┐
1521
▼ ▼ ▼
16-
rhodibot echidnabot sustainabot
17-
(git ops) (quality) (deps)
18-
22+
rhodibot echidnabot sustainabot ... + 8 more
23+
(git ops) (quality) (eco/econ)
24+
25+
1926
robot-repo-automaton
2027
(scan → fix → commit → PR)
2128
```
@@ -24,18 +31,20 @@ hypatia (scanner) → findings JSONL → fleet-coordinator.sh → dispatch
2431

2532
| Component | Location | Purpose |
2633
|-----------|----------|---------|
27-
| fleet-coordinator.sh | root | Orchestrates bot dispatching |
28-
| dispatch-runner.sh | scripts/ | Reads JSONL manifests, executes fixes |
29-
| process-review-findings.sh | scripts/ | Creates GitHub issues for review-tier |
30-
| fix-*.sh | scripts/ | 7 fix scripts for eliminate-tier patterns |
31-
| shared-context/ | shared-context/ | Rust crate for inter-bot communication |
32-
| robot-repo-automaton/ | robot-repo-automaton/ | Rust CLI: scan, fix, PR creation |
34+
| `fleet-coordinator.sh` | repo root | Orchestrates bot dispatching |
35+
| `dispatch-runner.sh` | `scripts/` | Reads JSONL manifests, executes fixes |
36+
| `process-review-findings.sh` | `scripts/` | Opens GitHub issues for review-tier findings |
37+
| `fix-*.sh` | `scripts/` | ~50 fix scripts for eliminate-tier patterns |
38+
| `shared-context/` | `shared-context/` | Rust crate for inter-bot communication |
39+
| `robot-repo-automaton/` | `robot-repo-automaton/` | Rust CLI: scan, fix, PR creation |
3340

3441
## Build & Run
3542

3643
```bash
3744
# Shell scripts (no build needed)
3845
bash fleet-coordinator.sh --help
46+
just maintenance-hard-pass /absolute/path/to/repo
47+
just scan-supervised
3948

4049
# Robot-repo-automaton (Rust)
4150
cd robot-repo-automaton
@@ -48,8 +57,8 @@ OPENSSL_NO_VENDOR=1 cargo build --release
4857

4958
```
5059
Eliminate (auto_execute >= 0.95) → Direct fix, no review
51-
Substitute (review >= 0.85) → proven module replacement, needs review
52-
Control (report < 0.85) → Human review required
60+
Substitute (review >= 0.85) Proven module replacement, needs review
61+
Control (report < 0.85) → Human review required
5362
```
5463

5564
## Code Style
@@ -62,8 +71,20 @@ Control (report < 0.85) → Human review required
6271

6372
## Critical Invariants
6473

65-
1. SCM files ONLY in `.machine_readable/6scm/` (never root)
66-
2. All shell scripts must validate untrusted input before use
67-
3. No hardcoded secrets — use env vars with `${VAR:-}` defaults
68-
4. Fix scripts must be idempotent (safe to run multiple times)
69-
5. Confidence thresholds gate all automated actions
74+
1. The seven canonical A2ML files (`STATE`, `META`, `ECOSYSTEM`,
75+
`AGENTIC`, `NEUROSYM`, `PLAYBOOK`, `ANCHOR`) live directly under
76+
`.machine_readable/`, per the `A2ML-REPO-TEMPLATE` in
77+
`hyperpolymath/standards`. (Earlier versions of this CLAUDE.md
78+
referenced a `.machine_readable/6scm/` subdir; that layout has been
79+
retired.)
80+
2. All shell scripts validate untrusted input before use.
81+
3. No hardcoded secrets — use env vars with `${VAR:-}` defaults.
82+
4. Fix scripts must be idempotent (safe to run multiple times).
83+
5. Confidence thresholds gate all automated actions.
84+
85+
## Repo health
86+
87+
- Open PRs / issues, dated session reports, and historical status
88+
snapshots: see [`docs/archive/`](../docs/archive/).
89+
- Component readiness (CRG grades + evidence): [`READINESS.md`](../READINESS.md).
90+
- Roadmap (all 11 bots): [`ROADMAP.adoc`](../ROADMAP.adoc).

README.adoc

Lines changed: 91 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,135 @@
1-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
2-
31
// SPDX-License-Identifier: PMPL-1.0-or-later
4-
// SPDX-FileCopyrightText: 2025 hyperpolymath
5-
6-
= Gitbot Fleet
7-
2+
// SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell
83

4+
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
95

10-
:toc: auto
6+
= Gitbot Fleet
7+
:toc: macro
118
:toclevels: 2
9+
:icons: font
1210

13-
Bot fleet for repository quality enforcement across the Hyperpolymath ecosystem.
11+
Bot orchestration hub for automated repository quality enforcement across the Hyperpolymath ecosystem (~500 repos).
12+
13+
toc::[]
1414

1515
== Overview
1616

17-
Gitbot Fleet is the central orchestration repository for all quality-enforcement bots in the Hyperpolymath ecosystem. Each bot specializes in a specific aspect of repository health and compliance.
17+
Gitbot Fleet coordinates 11 specialised bots through a shared-context layer. The
18+
`fleet-coordinator` dispatches Hypatia scanner findings to bots based on
19+
the **safety triangle**:
1820

19-
== Maintenance Gate Operations
21+
* **Eliminate** (`auto_execute >= 0.95`) — direct fix, no review
22+
* **Substitute** (`review >= 0.85`) — proven module replacement, needs review
23+
* **Control** (`report < 0.85`) — human review required
2024

21-
Use these commands to run maintenance gating across repos:
25+
== Architecture
2226

23-
[source,bash]
27+
[source]
2428
----
25-
just maintenance-hard-pass /absolute/path/to/repo
26-
just enroll-repos
27-
just scan-supervised
29+
hypatia (scanner) → findings JSONL → fleet-coordinator.sh → dispatch-runner.sh
30+
31+
┌───────────────────────────────┼───────────────────────────────┐
32+
▼ ▼ ▼
33+
rhodibot echidnabot sustainabot
34+
(git ops, RSR) (quality, proofs) (deps, eco/econ)
35+
│ │ │
36+
└─────────► shared-context layer ◄────────┐ │
37+
▼ ▼
38+
robot-repo-automaton (scan → fix → PR)
2839
----
2940

30-
`maintenance-hard-pass` enforces fail-on-warn release gating using the target repo maintenance script.
31-
32-
`enroll-repos` refreshes repository coverage metadata for gitbot-fleet and hypatia. Use `just enroll-repos /var$REPOS_DIR true` to also write enrollment directives into repos that already have `.machine_readable/`.
33-
34-
`scan-supervised` runs Hypatia across the supervised inventory (`~/.git-private-farm.scm`, `~/.git-private-repos`, or enrollment registry) and then processes findings for fleet dispatch.
41+
A full architecture map with completion state lives in
42+
link:docs/ARCHITECTURE.md[docs/ARCHITECTURE.md] (single source of truth).
43+
The historical `TOPOLOGY.md` dashboard is at the repo root.
3544

3645
== Bot Roster
3746

3847
[cols="1,3,1"]
3948
|===
40-
|Bot |Purpose |Status
49+
| Bot | Purpose | Status
50+
51+
| **rhodibot** | Git ops, RSR (Rhodium Standard Repositories) enforcement | Active
52+
| **echidnabot** | Formal verification, multi-prover dispatch, security fuzzing | Active
53+
| **sustainabot** | Eco/econ + technical-debt scoring; carbon-intensity gates | Active
54+
| **glambot** | Presentation: visual polish, WCAG accessibility, SEO, machine-readability | Active
55+
| **seambot** | Integration seam health, cross-component contracts, end-to-end flows | Active
56+
| **finishingbot** | Release readiness: placeholder removal, license + claim verification | Active
57+
| **accessibilitybot** | Accessibility-rule enforcement (WCAG, ARIA, contrast) | Active
58+
| **cipherbot** | Crypto + secret hygiene; policy-driven cipher checks | Active
59+
| **gsbot** | General-services: backup/load/export fixtures and operational scripts | Active
60+
| **panicbot** | Panic + crash-capture surfaces; surfaces broken assumptions | Active
61+
| **the-hotchocolabot** | Comfort / human-facing channels; non-blocking advisory output | Active
62+
|===
4163

42-
|**rhodibot**
43-
|RSR (Rhodium Standard Repositories) compliance validation. Structural checks, file presence, directory layout.
44-
|Active
64+
The component-readiness assessment (CRG grades, evidence) lives in
65+
link:READINESS.md[READINESS.md].
4566

46-
|**echidnabot**
47-
|Formal mathematical/statistical verification. Security fuzzing as secondary function.
48-
|Active
67+
== Build & Run
4968

50-
|**sustainabot**
51-
|Ecological and economic code standards. Carbon intensity, resource efficiency, technical debt modeling.
52-
|Active
69+
Maintenance gating commands:
5370

54-
|**glambot**
55-
|Presentation quality. Visual polish, accessibility (WCAG), SEO, machine-readability for AI/bots.
56-
|Complete
71+
[source,bash]
72+
----
73+
just maintenance-hard-pass /absolute/path/to/repo
74+
just enroll-repos
75+
just scan-supervised
76+
----
5777

58-
|**seambot**
59-
|Integration health testing. Cross-component communication, API contracts, end-to-end flows.
60-
|Active
78+
`maintenance-hard-pass` enforces fail-on-warn release gating using the
79+
target repo's maintenance script. `enroll-repos` refreshes repository
80+
coverage metadata; pass `/var$REPOS_DIR true` to also write enrollment
81+
directives into repos that already have `.machine_readable/`.
82+
`scan-supervised` runs Hypatia across the supervised inventory
83+
(`~/.git-private-farm.scm`, `~/.git-private-repos`, or the enrollment
84+
registry) and processes findings for fleet dispatch.
6185

62-
|**finishbot**
63-
|Release readiness. Placeholder removal, license validation, claim verification, execution testing.
64-
|Complete
65-
|===
86+
Other useful `just` recipes: `setup`, `build`, `test`, `doctor`, `heal`,
87+
`hypatia-scan`, `panic-scan`, `crg-grade`.
6688

67-
== Architecture
89+
For the Rust executor:
6890

69-
[source]
91+
[source,bash]
7092
----
71-
GITBOT FLEET
72-
┌──────────────────────────────────────────┐
73-
│ │
74-
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
75-
│ │ rhodibot│ │echidna │ │ sustainabot │ │
76-
│ │(RSR │ │(verify) │ │(eco/ │ │
77-
│ │ struct) │ │ │ │ econ) │ │
78-
│ └────┬────┘ └────┬────┘ └────┬────┘ │
79-
│ │ │ │ │
80-
│ ▼ ▼ ▼ │
81-
│ ┌─────────────────────────────────────┐ │
82-
│ │ SHARED CONTEXT LAYER │ │
83-
│ └─────────────────────────────────────┘ │
84-
│ │ │ │ │
85-
│ ▼ ▼ ▼ │
86-
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
87-
│ │ glambot │ │ seambot │ │finishing│ │
88-
│ │(present │ │(integr) │ │ -bot │ │
89-
│ │ ation) │ │ │ │(release)│ │
90-
│ └─────────┘ └─────────┘ └─────────┘ │
91-
│ │
92-
└──────────────────────────────────────────┘
93+
cd robot-repo-automaton
94+
OPENSSL_NO_VENDOR=1 cargo build --release
95+
./target/release/robot-repo-automaton scan /path/to/repo
96+
./target/release/robot-repo-automaton fix /path/to/repo --create-pr
9397
----
9498

95-
== Relationship to git-dispatcher
99+
== Documentation
96100

97-
This repository is a **satellite** of `git-dispatcher`, the central coordination hub for all Git automation in the Hyperpolymath ecosystem.
101+
Authoritative documents:
98102

99-
== License
103+
* link:EXPLAINME.adoc[EXPLAINME.adoc] — long-form architecture and rationale
104+
* link:ROADMAP.adoc[ROADMAP.adoc] — forward plan, all 11 bots
105+
* link:READINESS.md[READINESS.md] — Component Readiness Grades (CRG) assessment
106+
* link:docs/[docs/] — operational guides, performance notes, branch protection
107+
* link:docs/archive/[docs/archive/] — historical session reports kept for audit
108+
* link:docs/wiki-source/[docs/wiki-source/] — repo source for the GitHub wiki
100109

101-
PMPL-1.0-or-later - See LICENSE file.
110+
Quickstart guides:
102111

103-
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]
112+
* link:QUICKSTART-DEV.adoc[For developers]
113+
* link:QUICKSTART-USER.adoc[For users]
114+
* link:QUICKSTART-MAINTAINER.adoc[For maintainers]
115+
116+
== Relationship to git-dispatcher and OPSM
104117

105-
== OPSM Link
118+
This repository is a **satellite** of `git-dispatcher`, the central
119+
coordination hub for all Git automation in the Hyperpolymath ecosystem.
120+
Within OPSM (Operational Process State Management), gitbot-fleet is the
121+
execution fleet for batch operations:
106122

107123
[source]
108124
----
109125
OPSM Core
110-
|
111-
v
126+
127+
112128
gitbot-fleet (execution fleet for OPSM batch operations)
113-
114129
----
115130

131+
== License
116132

117-
== Architecture
133+
PMPL-1.0-or-later — see link:LICENSE[LICENSE] and link:NOTICE[NOTICE].
118134

119-
See link:TOPOLOGY.md[TOPOLOGY.md] for a visual architecture map and completion dashboard.
135+
image:https://img.shields.io/badge/License-PMPL--1.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"]

docs/ARCHITECTURE.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
<!-- SPDX-License-Identifier: PMPL-1.0-or-later -->
2+
<!-- SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell -->
3+
4+
# Gitbot Fleet — Architecture
5+
6+
This is the **single source of truth** for the gitbot-fleet architecture.
7+
The repo-root README links here; the `TOPOLOGY.md` dashboard at the repo
8+
root tracks live completion state.
9+
10+
## Pipeline
11+
12+
```
13+
hypatia (scanner)
14+
15+
▼ findings.jsonl
16+
fleet-coordinator.sh ← orchestrator, root of the repo
17+
18+
▼ dispatch manifest
19+
dispatch-runner.sh ← scripts/dispatch-runner.sh
20+
21+
├──────────────┬──────────────┬─────────────────────┐
22+
▼ ▼ ▼ ▼
23+
rhodibot echidnabot sustainabot ... 8 more bots
24+
(git ops) (verify) (eco/econ)
25+
│ │ │
26+
└──────────────┴──────────────┴────► shared-context layer
27+
(shared-context/, Rust crate)
28+
29+
30+
robot-repo-automaton
31+
(scan → fix → commit → PR)
32+
```
33+
34+
## Components
35+
36+
| Component | Path | Language | Purpose |
37+
|---|---|---|---|
38+
| `fleet-coordinator.sh` | repo root | bash | Orchestrates bot dispatching; reads Hypatia findings, builds manifests, dispatches per-bot |
39+
| `dispatch-runner.sh` | `scripts/` | bash | Reads JSONL manifests, executes per-finding fixes via `fix-*.sh` |
40+
| `process-review-findings.sh` | `scripts/` | bash | Opens GitHub issues for review-tier findings (Substitute / Control) |
41+
| `fix-*.sh` (~50 files) | `scripts/` | bash | One-shot fixers for eliminate-tier patterns (e.g. SPDX header, license file) |
42+
| `shared-context/` | `shared-context/` | Rust | Crate for inter-bot communication (RPC + state-sharing) |
43+
| `robot-repo-automaton/` | `robot-repo-automaton/` | Rust | CLI: scan, fix, PR creation |
44+
| `bots/*` | `bots/` | mostly Rust, AffineScript in sustainabot | Per-bot specialised logic |
45+
46+
## Safety triangle
47+
48+
```
49+
Eliminate (auto_execute >= 0.95) → Direct fix, no review
50+
Substitute (review >= 0.85) → Proven-module replacement, needs review
51+
Control (report < 0.85) → Human review required
52+
```
53+
54+
The thresholds gate every automated action: a fix script is only run when
55+
the upstream Hypatia finding's confidence meets the eliminate threshold;
56+
substitute-tier findings open PRs with a `needs-review` label; control-tier
57+
findings file issues.
58+
59+
## Critical invariants
60+
61+
1. **Machine-readable files** live in `.machine_readable/` (the canonical
62+
A2ML files — `STATE`, `META`, `ECOSYSTEM`, `AGENTIC`, `NEUROSYM`,
63+
`PLAYBOOK`, `ANCHOR` — sit directly there). See the
64+
`A2ML-REPO-TEMPLATE` in `hyperpolymath/standards`.
65+
2. **Shell scripts** validate untrusted input before use.
66+
3. **Secrets** come from env vars with `${VAR:-}` defaults — never
67+
hardcoded.
68+
4. **Fix scripts must be idempotent** (safe to run multiple times).
69+
5. **Confidence thresholds** gate every automated action.
70+
71+
## Repository position
72+
73+
Gitbot Fleet is a satellite of `git-dispatcher` (central Git-automation
74+
coordination) and the execution fleet for OPSM (Operational Process State
75+
Management) batch operations.

0 commit comments

Comments
 (0)