Skip to content

Comments

Add project documentation#1

Open
sunapi386 wants to merge 1 commit intomainfrom
docs/how-it-works
Open

Add project documentation#1
sunapi386 wants to merge 1 commit intomainfrom
docs/how-it-works

Conversation

@sunapi386
Copy link
Collaborator

Summary

  • Add docs/ folder with 10 documentation files covering every component in the system
  • Includes architecture diagram, API reference, CLI option tables, database schemas, and setup instructions
  • All details extracted directly from source code — no invented information

Files

File Covers
docs/README.md Overview, architecture diagram, data flow, tech stack
docs/backend-api.md Flask API endpoints and parameters
docs/embedding.md CLIP/MediaPipe CLI, SQLite schema, dedup logic
docs/pdf-extraction.md PyMuPDF text/image extraction, token injection
docs/document-processing.md GPT-4 resume/JD matching pipeline
docs/pose-detection.md MediaPipe pose landmarks, output formats
docs/vector-databases.md ClickHouse, Weaviate, SQLite integrations
docs/frontend.md React components, GraphQL, Docker deployment
docs/playground.md Experimental multi-pass GPT processing
docs/setup.md Installation, env vars, database setup

Test plan

  • Verify all markdown renders correctly on GitHub
  • Verify all cross-links between docs resolve

🤖 Generated with Claude Code

Docs cover the Flask API, embedding generation, PDF extraction,
GPT document processing, pose detection, vector databases, frontend,
playground scripts, and setup/configuration.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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