Skip to content

README cleanup for public repository quality #2

Description

@codetea-ping999

Goal

Make README.md accurate, public-safe, and easy to follow for first-time contributors and users.

Scope

  • README.md only

Background

The current README is strong in product vision, but it mixes implemented features, verification status, and planned items. It also contains absolute local paths that will not work on GitHub.

Required changes

  • Replace absolute local paths such as /Users/... with repository-relative links
  • Separate sections into:
    • Implemented
    • Verified
    • In progress / planned
  • Clean up or remove outdated checklist items that no longer reflect the current state
  • Move Quick Start closer to the top so first-time setup is easy to follow
  • Keep the explanation that model manifests are tracked in Git, while heavy model weights are not

Constraints

  • Do not change source code
  • Keep the current project intent and product framing
  • Do not overstate incomplete functionality

Acceptance criteria

  • Markdown links work correctly on GitHub
  • README clearly explains setup, run, and verification flow
  • README distinguishes current capabilities from planned work
  • Public readers can understand the repo without local-environment assumptions

Validation

  • Review rendered README.md on GitHub
  • Confirm that all repository links are relative and valid

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions