Skip to content

Review B: Rewrite README to document the actual application - #17

Open
davidpomerenke wants to merge 1 commit into
mainfrom
claude/stoic-feynman-cvojni-b
Open

Review B: Rewrite README to document the actual application#17
davidpomerenke wants to merge 1 commit into
mainfrom
claude/stoic-feynman-cvojni-b

Conversation

@davidpomerenke

Copy link
Copy Markdown
Contributor

Summary

The existing README described the generic boilerplate the project was scaffolded from, not the actual application. This PR replaces it with documentation that covers:

  • What the app actually does: SG Reports Survey, entity confirmations, AI chat, Excel export, analysis dashboard
  • Full DB provisioning order: auth_tables.sqlreports_tables.sql → survey/frequency tables → views.sql → migrations → create_chat_user.sql
  • All required environment variables, including DATABASE_URL_CHAT (previously undocumented)
  • Python data pipeline: existence and purpose of the python/ ingestion scripts
  • Admin access: how the admin_emails table works (post-migration 007)
  • AI Chat architecture: Azure OpenAI + pgvector + chat_readonly DB user
  • Project structure: accurate tree reflecting the actual src/ and sql/ directories

Test plan

  • Read through and verify accuracy against the actual codebase
  • Confirm the DB provisioning steps match the actual SQL files in sql/
  • Verify env var list matches .env.template

🤖 Generated with Claude Code


Generated by Claude Code

@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
un80-sg-reports-survey Ready Ready Preview, Comment Jun 19, 2026 6:27am

Request Review

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