Skip to content

Separate methodology content from README working dashboard #53

@jkleske

Description

@jkleske

Priority: P1

Problem

README.md (258 lines) serves two conflicting purposes:

  1. Methodology documentation — "The Evolution" (lines 12-18), "The Cognitive Shift" (lines 23-35), "The Manifesto" (lines 39-105), "Contributing" (lines 216-258) explain the philosophy to humans
  2. Agent working dashboard — "The Documentation Ecosystem" (lines 110-143), "The Progressive PRD" (lines 148-190), "Repository Structure" (lines 195-210) are what agents actually need at runtime

Since context-validation.sh tells agents to read README.md every session, they consume ~150 lines of methodology content that never changes and isn't actionable.

Proposed Change

Move methodology sections to docs/METHODOLOGY.md:

  • "The Evolution" (lines 12-18)
  • "The Cognitive Shift" (lines 23-35)
  • "The Manifesto" (lines 39-105)
  • "Contributing" (lines 216-258)

README.md becomes a 30-40 line working dashboard:

# PRD-Driven Context Engineering

> Template version: 3.0.0

## Current Status
<!-- Agent-updated: current PRD gate, active EPIC, blockers -->

## Documentation Ecosystem
<!-- Keep existing 3+1+SoT+Temp section (lines 110-143) -->

## Progressive PRD Lifecycle
<!-- Keep existing lifecycle table (lines 148-190) -->

## Repository Structure
<!-- Keep existing directory tree (lines 195-210) -->

## Links
- [Methodology & Philosophy](docs/METHODOLOGY.md)
- [Migration Guide](MIGRATION.md)
- [Changelog](CHANGELOG.md)

Files to Change

File Change
README.md Remove methodology sections, keep dashboard sections, add link to docs/METHODOLOGY.md
docs/METHODOLOGY.md New file. Receive "The Evolution", "The Cognitive Shift", "The Manifesto", "Contributing" sections
.claude/hooks/context-validation.sh No change needed — it already reads README.md, which will now be shorter

Acceptance Criteria

  • README.md is ≤50 lines and contains only: project name, current status area, Documentation Ecosystem, Progressive PRD lifecycle, Repository Structure, and links
  • docs/METHODOLOGY.md exists and contains all moved methodology content
  • No content is deleted — everything is preserved in the new location
  • Links between README.md and docs/METHODOLOGY.md work (relative paths)
  • README_template.md is updated to match the new README structure (if it still exists as a separate template)

Verification

  1. wc -l README.md should show ≤50 lines
  2. test -f docs/METHODOLOGY.md should pass
  3. All original README content is findable via grep -r "The Manifesto" docs/
  4. GitHub renders both files correctly (check via gh repo view or browser)

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions