Skip to content

docs: Inline phase summary table in README to clarify build progress #1

@moonrunnerkc

Description

@moonrunnerkc

Context

As "Future Brad" (or any contributor) skimming the README for implementation details, the vague "Phase 1+" mention in the "Current Status" section left me guessing about what's in progress vs. planned. Without a quick inline overview, it takes extra time cross-referencing commit history or chat logs to understand the phased build.

Steps to Reproduce

  1. Clone the repo: git clone https://github.com/moonrunnerkc/adaptive-belief-ecology-system.git
  2. Open README.md → Scan for "Phase 1+" → No breakdown or table explaining components per phase.
  3. Try contributing to agents → Realize phases aren't surfaced, leading to mismatched assumptions.

Expected vs Actual

  • Expected: README "Development" section has a simple table summarizing phases (e.g., | Phase | Status | Key Components |) for at-a-glance tracking.
  • Actual: Phases referenced but undefined → Contributors hunt commits instead of diving in.

Logs/ Details

  • README "Current Status" section - shows "Phase 1+" without details.
  • No logs needed; it's a discoverability gap.

Suggested Fix

Add a "Phased Development" subsection in README with a markdown table like:

Phase Status Key Components
0 Done Skeleton setup
1 In Progress Belief models & storage
And update as phases complete. Keeps everything self-contained—no external files needed.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions