Skip to content

Commit 28b4a12

Browse files
Jammy2211claude
authored andcommitted
docs: register PyAutoGut (Gut organ) in README and PyAutoScientist docs
Add the Gut organ to the hand-maintained organ tables and PyAutoScientist docs now that PyAutoGut exists: README organ table, the organism concept page (organ row + five→six count + instance-organ list), the docs index (repo count + organ toctree), and a new organs/gut.md page. The canonical ORGANISM.md/AGENTS.md generated tables already carry Gut. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 4e4258d commit 28b4a12

4 files changed

Lines changed: 67 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ version:
1717
| Heart | PyAutoHeart | is it healthy — the release-readiness verdict |
1818
| Hands | PyAutoBuild | do it — packaging, tagging, PyPI releases |
1919
| Memory | PyAutoMemory | what we know — long-term scientific knowledge |
20+
| Gut | PyAutoGut | what we shed — condemned branches, stashes and dead code, held recoverably then voided |
2021

2122
Agents live under `agents/` in two tiers: **conductors** (front doors a
2223
human drives; they decide and act) and **faculties** (read-only judgments

docs/concepts/organism.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ it and adds the framework/instance distinction an adopter needs.
1414
| **Heart** | PyAutoHeart | Decides whether the organism is *healthy*. `pyauto-heart readiness` is the authoritative GREEN/YELLOW/RED release gate. An observer: never writes into other repos, never triggers a build. |
1515
| **Hands** | PyAutoBuild | *Does* — packaging, tagging, notebook generation, PyPI releases. A pure executor: never re-derives a gate decision. |
1616
| **Memory** | PyAutoMemory | *Knows* — long-term domain knowledge: literature wikis, concepts, bibliographies. Pull-only; consulted, never load-bearing at runtime. |
17+
| **Gut** | PyAutoGut | *Sheds* — the lifecycle of condemned self-material (stale branches, stashes, dead code/tests): holds each as a durable, recoverable git ref through a transit window, then **voids** it on a sweep. The storage mirror of Memory (retention ↔ release); the hygiene conductor drives it, as vitals reads Heart. |
1718

1819
Everything else — the libraries being developed, their example workspaces,
1920
test suites, tutorials — is a **satellite**: a capability the organism works
@@ -33,15 +34,16 @@ organ has to be trusted to police itself.
3334

3435
## Framework vs instance
3536

36-
The five organs split on one line that matters for adoption:
37+
The six organs split on one line that matters for adoption:
3738

3839
- **Framework organs — Brain, Heart, Hands.** Code, agents, checks,
3940
pipelines. Domain facts appear only in declared config surfaces (tables
4041
and policy files, not logic), and a drift check — the
4142
{ref}`tenant firewall <tenant-firewall>` — keeps it that way.
42-
- **Instance organs — Mind, Memory.** Committed state and knowledge. These
43-
are *inherently yours*: an adopter never forks the upstream Mind or Memory
44-
content, they create their own repos with the same documented shape.
43+
- **Instance organs — Mind, Memory, Gut.** Committed state, knowledge, and
44+
shed material. These are *inherently yours*: an adopter never forks the
45+
upstream Mind, Memory or Gut content, they create their own repos with the
46+
same documented shape.
4547

4648
One more principle worth knowing before you read anything else:
4749
**one canonical page per fact.** Organ boundaries live in ORGANISM.md;

docs/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
PyAutoScientist is a working, opinionated reference implementation of an
44
**AI-agent development organism** for human-led, natural-language software
5-
development: a set of five git repositories — Mind, Brain, Heart, Hands,
6-
Memory — through which you lead a multi-repo project in plain English. You
5+
development: a set of six git repositories — Mind, Brain, Heart, Hands,
6+
Memory, Gut — through which you lead a multi-repo project in plain English. You
77
describe what you want; AI agents plan, implement, test, gate and release
88
it; you make every judgment call.
99

@@ -57,6 +57,7 @@ organs/brain
5757
organs/heart
5858
organs/build
5959
organs/memory
60+
organs/gut
6061
```
6162

6263
```{toctree}

docs/organs/gut.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Gut — PyAutoGut
2+
3+
**What it owns:** the lifecycle of *condemned self-material* — the stale
4+
branches, `git stash` entries, dead code and retired tests a hygiene sweep is
5+
95%-but-not-100% sure is trash. Code that is not *wrong*, just *done*. Gut is
6+
the storage mirror of Memory: Memory holds what the organism **keeps**, Gut
7+
holds what it **sheds** — retention ↔ release.
8+
9+
**Repo:** [PyAutoLabs/PyAutoGut](https://github.com/PyAutoLabs/PyAutoGut)
10+
11+
## The defining function: elimination
12+
13+
Gut is a storage organ that ends in **deletion** — it performs the final void
14+
itself. (An organ that only filtered and handed waste downstream would be a
15+
spleen; the one that *voids* is the gut.) Between condemnation and deletion it
16+
holds each item in a **transit window**: a staging state that is neither "keep"
17+
nor "delete now", with a clock on it.
18+
19+
## Lifecycle: condemn → transit → void
20+
21+
- **Condemn** — the Brain's hygiene conductor files an entry into the
22+
`condemned.md` manifest in the Mind (symmetric to `parked.md`). Fragile forms
23+
— local unmerged branches, stashes — are archived to a durable ref here
24+
*first*.
25+
- **Transit** — the entry carries a `sweep-after` date. Until then it is
26+
**recoverable**: restore the branch or stash from its archive ref. The
27+
holding window *is* the gut's transit time, with a clock on it.
28+
- **Void** — a batch `sweep` runs the existing `repo_cleanup` safety gates
29+
against entries past their date and eliminates them.
30+
31+
## Storage model
32+
33+
- **Payload = durable git refs, never lossy markdown.** Fragile forms are
34+
materialised as real commits and pushed under the
35+
`refs/heads/archive/condemned/<name>` prefix into this repo — the *attic
36+
remote* — before the local copy is deleted. Recovery is a checkout. (It is a
37+
branch prefix, not a custom `refs/archive/*` namespace: GitHub only accepts
38+
pushes to `refs/heads/*` and `refs/tags/*`.)
39+
- **Catalog = `condemned.md` in the Mind** (symmetric to `parked.md`). The
40+
`.md` is the index; the refs here are the payload. Merged branches skip the
41+
pen entirely — reachable from `main` forever, so the conductor recommends them
42+
straight to deletion.
43+
44+
## The driver split
45+
46+
Gut *holds and voids*; it decides nothing. The Brain's hygiene conductor decides
47+
what to condemn and when to sweep — the same split as **Heart ↔ vitals**: the
48+
organ does the work, the conductor reasons. The `bin/pyauto-gut` entrypoint
49+
provides the mechanics: `archive`, `recover`, `list`, `void`.
50+
51+
## For an adopter
52+
53+
You do not fork this repo's contents — the condemned refs are your organism's
54+
own shed material. You create your own Gut with the same shape: an attic remote
55+
that accepts `archive/condemned/*` refs, the `condemned.md` catalog in your
56+
Mind, and the hygiene conductor wired to drive it. Like Mind and Memory, Gut is
57+
an **instance organ** — inherently yours.

0 commit comments

Comments
 (0)