Update app-architecture.md to match actual codebase #253

Open
opened 2026-06-18 23:47:22 +00:00 by ldraney · 0 comments
Owner

Type

Feature

Lineage

Standalone -- discovered during QA board validation and pipeline health check.

Repo

ldraney/landscaping-assistant

User Story

As a developer
I want app-architecture.md to reflect the real data model and code structure
So that new contributors and agents don't build against aspirational schema that doesn't exist

Context

The ERD shows Business, UserBusiness, PropertyComment models that were never implemented. Meanwhile 5 real models added over the past month are missing: CrewMember, DailyNote, DayExclusion, FeatureFlag, ServiceRequest. The Rails structure section is also missing DaysController, ProfileController, ClientErrorsController, ScheduleDigester, and 7 Stimulus controllers.

File Targets

Files the agent should modify or create:

  • docs/app-architecture.md -- update ERD, model descriptions, Rails structure, key design decisions

Files the agent should NOT touch:

  • Any code files -- docs-only change

Feature Flag

none

Acceptance Criteria

  • ERD matches db/schema.rb with real column types
  • All controllers in app/controllers/ are listed
  • All Stimulus controllers in app/javascript/controllers/ are listed
  • Aspirational models clearly marked as planned/not-yet-implemented
  • Key design decisions updated for global auth enforcement, schedule digestion, DayExclusion

Test Expectations

  • No code changes, no tests needed
  • Mermaid ERD renders correctly

Constraints

  • Keep the same document structure and section ordering
  • Don't remove aspirational models entirely, just move to a Planned section

Checklist

  • PR opened
  • No unrelated changes
  • landscaping-assistant -- project this affects
### Type Feature ### Lineage Standalone -- discovered during QA board validation and pipeline health check. ### Repo `ldraney/landscaping-assistant` ### User Story As a developer I want app-architecture.md to reflect the real data model and code structure So that new contributors and agents don't build against aspirational schema that doesn't exist ### Context The ERD shows Business, UserBusiness, PropertyComment models that were never implemented. Meanwhile 5 real models added over the past month are missing: CrewMember, DailyNote, DayExclusion, FeatureFlag, ServiceRequest. The Rails structure section is also missing DaysController, ProfileController, ClientErrorsController, ScheduleDigester, and 7 Stimulus controllers. ### File Targets Files the agent should modify or create: - `docs/app-architecture.md` -- update ERD, model descriptions, Rails structure, key design decisions Files the agent should NOT touch: - Any code files -- docs-only change ### Feature Flag none ### Acceptance Criteria - [ ] ERD matches `db/schema.rb` with real column types - [ ] All controllers in `app/controllers/` are listed - [ ] All Stimulus controllers in `app/javascript/controllers/` are listed - [ ] Aspirational models clearly marked as planned/not-yet-implemented - [ ] Key design decisions updated for global auth enforcement, schedule digestion, DayExclusion ### Test Expectations - [ ] No code changes, no tests needed - [ ] Mermaid ERD renders correctly ### Constraints - Keep the same document structure and section ordering - Don't remove aspirational models entirely, just move to a Planned section ### Checklist - [ ] PR opened - [ ] No unrelated changes ### Related - `landscaping-assistant` -- project this affects
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ldraney/landscaping-assistant#253
No description provided.