Skip to content

Add initial CBE project docs: AGENTS.md, architecture, and roadmap#2

Open
alethkit wants to merge 1 commit into
cbefrom
codex/implement-github-issue-#1-and-create-pr
Open

Add initial CBE project docs: AGENTS.md, architecture, and roadmap#2
alethkit wants to merge 1 commit into
cbefrom
codex/implement-github-issue-#1-and-create-pr

Conversation

@alethkit
Copy link
Copy Markdown
Owner

Motivation

  • Introduce project-level guidance for the CBE fork derived from QBE to capture development conventions and constraints.
  • Record the intended transformation pipeline and artifact model to guide future implementation and design decisions.
  • Provide a concise roadmap of milestones from preserving the baseline to provenance and invalidation to align priorities.

Description

  • Add AGENTS.md containing CBE contributor instructions including preservation of QBE behavior, keeping master as the upstream baseline, working on cbe (or work in Codex Cloud), and requirements for tests or manual validation for behavior-changing patches.
  • Add docs/architecture.md that outlines the planned transformation and artifact pipeline from QBE IL through SSA/block-argument normalization to olog-shaped artifacts, derived facts, proof obligations, and provenance.
  • Add docs/roadmap.md listing milestones M0–M5 covering baseline preservation, machine-readable IR dump, phi-to-block-argument normalization, olog JSON export, structural proof obligations, and dependency provenance/invalidation.

Testing

  • No automated tests were added or executed as part of this documentation-only change.

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant