Skip to content

EPIC: Public-ready documentation overhaul #65

@krisoye

Description

@krisoye

Context

Making the repo public for portfolio presentation. The current README has outdated technical details (SSE transport, requirements.txt, black formatter), internal infrastructure references (game-da-god IP, project board links), an "Under Development" framing, and a dead link to docs/ARCHITECTURE.md. It needs to present the project as a polished, production-quality tool.

Scope

  1. Rewrite README.md — Professional, employer-facing, no internal details
  2. Create docs/ARCHITECTURE.md — Lightweight component/data flow overview
  3. Update LICENSE — Switch to MIT (align with pyproject.toml)
  4. Scrub internal references — Remove IPs, server names, internal links

Design Principles

  • Frame as a general-purpose audio analysis tool (not interview-specific)
  • Highlight engineering maturity: 440+ tests, CI matrix, systemd hardening, GPU support
  • Show example output (abbreviated JSON) to demonstrate capabilities
  • Add CI/Python/License badges
  • Keep deployment docs but genericize (no private infra names)

Sub-Issues

Cross-Repo (Same Initiative)

Acceptance Criteria

  • No internal IPs, server names, or private project links in any committed file
  • README accurately reflects current transport (Streamable HTTP), install method (pyproject.toml), and commands
  • docs/ARCHITECTURE.md exists with component diagram and data flow
  • LICENSE file is MIT
  • A stranger can understand what this project does and how to use it from the README alone

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1-highImportant, fix soontype:docsDocumentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions