Skip to content

Commit d843847

Browse files
committed
docs: add portfolio context contracts
1 parent b626d0f commit d843847

2 files changed

Lines changed: 102 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# AGENTS.md
2+
3+
## What This Project Is
4+
5+
`GithubRepoAuditor` is the workbook-first portfolio operating system for repo truth and weekly review. It generates the canonical local portfolio truth snapshot consumed by downstream dashboards, reports, command-center surfaces, and planning lanes.
6+
7+
## Current State
8+
9+
The current machine-readable truth surface is `output/portfolio-truth-latest.json`. Compatibility Markdown, workbooks, dashboards, and reports are derived surfaces; do not treat them as canonical inputs unless a task is specifically about that artifact.
10+
11+
## Stack
12+
13+
- Python
14+
- `uv`
15+
- pytest
16+
- ruff
17+
- Local JSON, Markdown, HTML, workbook, and control-center outputs
18+
19+
## How To Run
20+
21+
Refresh the local portfolio truth snapshot:
22+
23+
```sh
24+
uv run python -m src.cli report saagpatel --portfolio-truth
25+
```
26+
27+
Useful checks for repo changes:
28+
29+
```sh
30+
uv run ruff check .
31+
uv run pytest -q
32+
```
33+
34+
Use narrower tests when the change is scoped and the full suite would be disproportionate.
35+
36+
## Known Risks
37+
38+
- `output/portfolio-truth-latest.json` is generated state, but it is also the current truth surface for other local workflows. Regenerate it deliberately after catalog or context changes.
39+
- Do not let generated reports, old dashboards, or historical registry files override the latest portfolio truth snapshot.
40+
- Do not read or emit secrets, `.env` values, keychains, OAuth stores, raw private transcripts, raw logs, browser profiles, or credential-bearing configs while auditing repos.
41+
42+
## Next Recommended Move
43+
44+
When repairing portfolio context, keep the attention contract tight: improve default-attention repos only when the work supports a real publish, park, archive, security, release, dirty-worktree, owner, active-product, bridge/Notion/sync, or cost decision.

config/portfolio-catalog.yaml

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,29 @@ groups:
7474
tool_provenance: claude-code
7575
order: 70
7676
repos:
77+
_machine/machine-control-tower/bin:
78+
owner: d
79+
purpose: nested command-bin folder under the machine control tower; not an independent portfolio project
80+
lifecycle_state: archived
81+
review_cadence: monthly
82+
intended_disposition: archive
83+
category: infrastructure
84+
tool_provenance: codex
85+
maturity_program: archive
86+
target_maturity: archived
87+
notes: Enrolled only to prevent the nested bin directory from being treated as a standalone decision-needed project.
88+
agent-bridge:
89+
owner: d
90+
purpose: local SQLite-backed MCP shared-state bus for coordinating coding agents
91+
lifecycle_state: active
92+
criticality: high
93+
review_cadence: weekly
94+
intended_disposition: maintain
95+
category: infrastructure
96+
tool_provenance: codex
97+
maturity_program: maintain
98+
target_maturity: operating
99+
automation_eligible: false
77100
AIGCCore:
78101
owner: d
79102
purpose: local-first AI governance core with offline enforcement and hash-chained
@@ -407,11 +430,17 @@ repos:
407430
tool_provenance: claude-code
408431
mcpforge:
409432
owner: d
433+
purpose: FastMCP server generator and validation toolkit
410434
lifecycle_state: active
435+
criticality: high
411436
review_cadence: weekly
412437
intended_disposition: maintain
438+
category: infrastructure
413439
tool_provenance: claude-code
440+
maturity_program: maintain
441+
target_maturity: operating
414442
automation_eligible: false
443+
notes: Use docs/CURRENT-STATE.md for dated release posture, but AGENTS.md is the current primary context contract required by portfolio truth.
415444
ModelColosseum:
416445
owner: d
417446
lifecycle_state: active
@@ -837,10 +866,37 @@ repos:
837866
intended_disposition: experiment
838867
hermes-harness-foundation:
839868
owner: d
840-
lifecycle_state: active
869+
purpose: local-only manifesto-stage foundation for the planned Frontier Sentinel orchestrator
870+
lifecycle_state: experimental
841871
review_cadence: weekly
842-
intended_disposition: maintain
872+
intended_disposition: experiment
873+
category: infrastructure
874+
maturity_program: experiment
875+
target_maturity: functional
876+
notes: Manifesto-stage and pre-implementation; keep non-default until the operator decides push/build/park.
877+
operator-os-docs:
878+
owner: d
879+
purpose: architecture and coherence documentation package for the local Operator OS
880+
lifecycle_state: experimental
881+
review_cadence: monthly
882+
intended_disposition: experiment
843883
category: infrastructure
884+
tool_provenance: codex
885+
maturity_program: experiment
886+
target_maturity: functional
887+
notes: Evidence/history-style docs; use only when a cross-system architecture or conformance decision is active.
888+
portfolio-index:
889+
owner: d
890+
purpose: public-safe static portfolio index for hiring-manager review
891+
lifecycle_state: active
892+
review_cadence: monthly
893+
intended_disposition: maintain
894+
category: vanity
895+
tool_provenance: claude-code
896+
maturity_program: maintain
897+
target_maturity: operating
898+
automation_eligible: false
899+
notes: Keep manual-only unless code or deployment work is active; resume and custom-domain decisions are mostly external to this repo.
844900
rag-knowledge-base:
845901
owner: d
846902
lifecycle_state: active

0 commit comments

Comments
 (0)