Skip to content

[Roadmap Misalignment] Roadmap Implies Product/Prod Readiness, README Does Not #7

Description

@bjl13

Roadmap/README Misalignment: Product Roadmap Language vs Reference Architecture

The roadmap (roadmap.md) uses terms and outlines work such as "operational hardening," "production-quality async Python agent," and multi-phase feature goals. In contrast, the README is adamant that this repo is reference architecture, not a stable or production product.

Why this matters:

  • New users might expect stable, production-grade features when the intent is documentation, prototype, and reference.
  • The boundary between "reference," "experimental," and "production-ready" code is unclear.

What to do:

  • Audit language, labels, and organization in both README and roadmap, clarifying what is reference sample/architecture (default), what will become production-ready (if anything), and what is experimental.
  • Add clear warning/disclaimer boxes in README and roadmap for non-production sections or features.
  • Update feature status and docs as work progresses, using issues and badges.

Relates to parent: [META] Misalignment: README, Roadmap, and Repo Structure

Activity

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

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