Skip to content

docs: modernize README, architecture and research documentation - #28

Merged
Pentexa merged 1 commit into
mainfrom
docs/modernization-2026
Nov 8, 2026
Merged

Pentexa merged 1 commit into
mainfrom
docs/modernization-2026

Conversation

@Pentexa

@Pentexa Pentexa commented Nov 8, 2026

Copy link
Copy Markdown
Owner

Modernizes the documentation system for the METARGON research project.

Changes

  • Rewrote README.md (landing page): crow-inspired motivation, agent loop (observe/learn/hypothesize/plan/act), research status, milestones from CORVID v0.1 through METARGON v0.11, Academy/EVREN and independent audit results (positive and negative), Mermaid architecture diagram, quick-start commands, roadmap, limitations, contribution/license. Preserves existing branding and banner.
  • Added docs/README.md - documentation index.
  • Added docs/GETTING_STARTED.md - prerequisites, verified first commands, Academy CLI + EVREN reference.
  • Added docs/ARCHITECTURE_OVERVIEW.md - implementation-level architecture (belief, hypothesis memory, planner, Academy, EVREN validation chain, evaluation).
  • Added docs/RESEARCH_INDEX.md - authoritative map of all versions/reports/findings with full result tables and explicit unmerged-work boundaries.
  • Added docs/BENCHMARK_GUIDE.md - verified reproduction commands for every benchmark, ablation, suite, and audit.

Accuracy & hygiene

  • All numbers are transcribed from committed research reports/raw results; no fabricated metrics. v0.12 and Academy v0.4 are explicitly not presented as completed.
  • Verified: python scripts/check_repo.py passes (merge markers, Markdown links, Python compile); benchmark/CLI entry points smoke-tested (v0.11 benchmark run, Academy CLI loads, unit discovery OK).
  • Only documentation files changed (no source/experiment/test/CI/raw-result modifications).

Copilot AI balanced review requested due to automatic review settings November 8, 2026 16:13

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@Pentexa
Pentexa merged commit a09faa3 into main Nov 8, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants