Skip to content

Add AI agent onboarding and project context documentation - #35

Merged
RadValentin merged 6 commits into
mainfrom
copilot/document-explanation-for-ai-agent
Jul 28, 2026
Merged

Add AI agent onboarding and project context documentation#35
RadValentin merged 6 commits into
mainfrom
copilot/document-explanation-for-ai-agent

Conversation

Copilot AI commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

No structured project overview existed that could be fed to an AI agent to bootstrap context for feature discussions and development conversations.

Changes

  • PROJECT_CONTEXT.md (new, repo root) — comprehensive reference document covering:
    • Project purpose, live URL, and repo URL
    • Full tech stack table (backend: Django/DRF/PostgreSQL/NumPy/scikit-learn; frontend: React 19/TypeScript/Vite/Axios/YouTube IFrame API; infra: Docker/Nginx/Certbot)
    • Architecture diagram (Browser → Nginx → Gunicorn → Django → Postgres)
    • Data model field-level breakdown (Track, Artist, Album, GenreDortmund, GenreRosamerica)
    • All 16 audio features (11 perceptual + 5 MIREX moods) with normalization notes
    • Step-by-step recommendation algorithm (pre-filter → weight → cosine similarity → popularity re-rank)
    • Full REST API endpoint table with request/response shapes for /api/v1/recommend/
    • AcousticBrainz dataset details and ingest pipeline summary
    • Frontend component layout and auto-advance behavior
    • Deployment setup, required env vars, known limitations, and codebase conventions

@RadValentin RadValentin left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made some tweaks to the documents and I'm requesting the following changes.

Comment thread docs/PROJECT_CONTEXT.md Outdated
Comment thread docs/PROJECT_CONTEXT.md Outdated
Comment thread docs/PROJECT_CONTEXT.md Outdated
Comment thread docs/PROJECT_CONTEXT.md
Comment thread .gitattributes
Copilot AI requested a review from RadValentin July 28, 2026 13:28
@RadValentin RadValentin changed the title Add PROJECT_CONTEXT.md for AI agent onboarding Add AI agent onboarding and project context documentation Jul 28, 2026
@RadValentin
RadValentin marked this pull request as ready for review July 28, 2026 15:18
@RadValentin
RadValentin merged commit d258ae0 into main Jul 28, 2026
3 checks passed
@RadValentin
RadValentin deleted the copilot/document-explanation-for-ai-agent branch July 28, 2026 15:18
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.

2 participants