Skip to content
This repository was archived by the owner on Aug 11, 2026. It is now read-only.

docs: comprehensive project documentation for handoff - #891

Open
jon-myers wants to merge 1 commit into
mainfrom
docs/project-documentation
Open

docs: comprehensive project documentation for handoff#891
jon-myers wants to merge 1 commit into
mainfrom
docs/project-documentation

Conversation

@jon-myers

Copy link
Copy Markdown
Collaborator

Summary

  • Adds 13-chapter project documentation in docs/project/ (3,461 lines of markdown)
  • Covers the full IDTAP project holistically: web app, Python API, deployment, research context
  • Includes an HTML viewer (docs/project/viewer.html) for browsing locally via python3 -m http.server
  • Updates .gitignore to track docs/project/ while keeping auto-generated TypeDoc ignored

Documentation Structure

  1. Project Overview -- Mission, funding, publications, impact metrics
  2. Development History -- 12 phases over 4 years, 4,010 commits
  3. System Architecture -- Full-stack overview with data flow diagrams
  4. Domain Model -- Piece→Phrase→Trajectory→Pitch, Raga, Meter/Tala, Assemblage
  5. Spectrogram System -- End-to-end CQ pipeline, Web Worker rendering, cascade invalidation
  6. Audio Synthesis -- 6 AudioWorklet engines, polyphonic routing architecture
  7. Editor & Rendering -- D3 SVG, drag dots, chunked lazy loading, full 61-component UI inventory
  8. Analysis & Query -- Pattern matching, pitch prevalence, DN_Extractor, assemblage analysis
  9. Database & Storage -- MongoDB schema for all 15 collections, permission evolution, backup system
  10. Python API -- PyPI package architecture, OAuth, data model parity
  11. Deployment -- CI/CD, server management, backup procedures
  12. Known Issues & Roadmap -- ~105 open issues categorized, architecture recommendations (including backend consolidation)
  13. Onboarding Guide -- Setup, key files, common tasks, gotchas

Test plan

  • All markdown files render correctly in the HTML viewer
  • .gitignore correctly tracks docs/project/ while ignoring TypeDoc output

🤖 Generated with Claude Code

13-chapter documentation covering the full IDTAP project:
- Project overview, intellectual foundations, and research publications
- 4-year development history (4,010 commits across 12 phases)
- System architecture (frontend, backend, Python API, deployment)
- Domain model (Piece/Phrase/Trajectory/Pitch hierarchy, Raga, Meter, Assemblage)
- Spectrogram system (CQ pipeline, Web Worker rendering, cascade invalidation)
- Audio synthesis engines (Karplus-Strong, Sarangi waveguide, Klatt, Chikari)
- Editor and rendering (D3 SVG, drag dots, lazy loading, full UI inventory)
- Analysis and query systems (pattern matching, pitch prevalence, DN_Extractor)
- Database and storage (MongoDB schema, permissions, backups, migrations)
- Python API (PyPI package architecture and integration)
- Deployment and infrastructure (CI/CD, server management, backups)
- Known issues and roadmap (~105 open issues, architecture recommendations)
- Onboarding guide for new developers

Includes an HTML viewer for browsing docs locally.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant