Skip to content

docs: polish README + clean up untracked brief files#18

Merged
saisri27 merged 1 commit into
mainfrom
sai
May 8, 2026
Merged

docs: polish README + clean up untracked brief files#18
saisri27 merged 1 commit into
mainfrom
sai

Conversation

@saisri27

@saisri27 saisri27 commented May 8, 2026

Copy link
Copy Markdown
Owner

Rewrites the README to reflect what actually exists (Cloud Run, retrain workflow, cost monitoring, BQ backup were all listed as 'coming next' but have been live for days), adds a Mermaid architecture diagram that renders natively on GitHub, lists the live URLs at the top, and gitignores the personal brief drafts that have been polluting git status since the start of the redesign work.

README rewrite:
- Live URL table at the top (web app, API, /health, /admin/llm-cost)
- Mermaid architecture diagram (renders natively on GitHub)
- "What's actually there" matrix replaces the old stale "coming next"
  section that listed Cloud Run + retrain + cost monitoring as future
  work — all of those have been live for days
- Updated repo layout (adds ranker.py, build_training_data.py,
  notebooks/train_ranker.py, scripts/, .github/workflows/)
- Cleaner deployment section
- Drops the legacy FastAPI/ wine-classifier mention

.gitignore:
- Stop polluting `git status` with PROJECT_BRIEF.html, the architecture
  PDF, and other personal drafts that have been sitting untracked since
  the start of the redesign work.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@saisri27 saisri27 merged commit f6f604e into main May 8, 2026
4 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.

1 participant