Skip to content

Add comprehensive limitations and design decisions documentation - #43

Merged
lgarraza merged 1 commit into
mainfrom
claude/project-thread-yeaw4u
Nov 6, 2026
Merged

lgarraza merged 1 commit into
mainfrom
claude/project-thread-yeaw4u

Conversation

@lgarraza

@lgarraza lgarraza commented Nov 6, 2026

Copy link
Copy Markdown
Owner

Summary

This PR adds a new LIMITATIONS.md document that provides transparent documentation of the app's constraints, design decisions, and attempted features that didn't work out. It also updates the README to reference this new documentation.

Changes

  • New file: docs/LIMITATIONS.md - Comprehensive documentation covering:

    • What the app is good at (big-screen editing, library/backups, generator)
    • Core constraint explanation (app reads flash, not live state)
    • Detailed account of Attempt 1 (live editing over USB) - what was tried, what worked, what didn't, and why it was parked
    • Idea 2 (app as transport with MIDI out) - why it wasn't started
    • Explanation of why KeyStep 37 MK2 and other Arturia devices aren't supported
    • Known limitations (firmware version, drums in scenes, slow reads, Windows port exclusivity, unsigned binaries, VST3-only, etc.)
    • Guidance for contributors wanting to build on the project, with pointers to relevant source files
  • Updated: README.md - Added reference to the new LIMITATIONS.md document in the "Status and limits" section

Rationale

This documentation serves several purposes:

  • Sets honest expectations for users about what the app can and cannot do
  • Explains the architectural constraints and why certain features aren't feasible
  • Provides transparency about attempted approaches and why they were abandoned
  • Helps potential contributors understand the codebase and where to focus efforts
  • Reduces support burden by preemptively addressing common questions

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01F2632objosZQbFrFzRRhWL
@lgarraza
lgarraza merged commit 2dde5f9 into main Nov 6, 2026
4 checks passed
@lgarraza
lgarraza deleted the claude/project-thread-yeaw4u branch November 6, 2026 20:44
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