Future ideas. #3929

ildyria · 2026-01-03T23:55:46Z

Summary by CodeRabbit

Documentation
- Added comprehensive planning and specification documents for two new features: Album List View Toggle and Photo Star Rating Filter.
- Expanded architecture roadmap with two new planned features (Features 005 and 006) in Planning status.
- Added six new open questions to guide upcoming architecture and API design decisions.
- Created detailed implementation task checklists and acceptance criteria for feature development.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2026-01-03T23:56:00Z

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation for two new UI features: Album List View Toggle (Feature 005) and Photo Star Rating Filter (Feature 006). It includes planning documents, detailed specifications, implementation task breakdowns, and updates to the architecture roadmap and open questions tracking. No source code changes are included.

Changes

Cohort / File(s)	Summary
Feature 005: Album List View Toggle `docs/specs/4-architecture/features/005-album-list-view/plan.md`, `spec.md`, `tasks.md`	Comprehensive planning, specification, and task documentation for grid/list view toggle in albums, including state management (localStorage persistence), new components (AlbumListItem.vue, AlbumListView.vue), modifications to AlbumHero.vue and AlbumThumbPanel.vue, and 9 implementation increments (I1–I9) with detailed testing and accessibility requirements.
Feature 006: Photo Star Rating Filter `docs/specs/4-architecture/features/006-photo-rating-filter/plan.md`, `spec.md`, `tasks.md`	Planning, specification, and task documentation for client-side 5-star photo rating filter with state management via Pinia store (session-only persistence), filtering logic, toggle UI in PhotoThumbPanelControl.vue, and 11 implementation increments (I1–I11) covering accessibility and responsive design.
Architecture Documentation `docs/specs/4-architecture/open-questions.md`, `roadmap.md`, `_current-session.md`	Added six new open questions (Q-007-01 to Q-007-06) addressing pagination strategy, API design, and configuration; added Features 005 and 006 to the Active Features table in the roadmap; expanded current session documentation with feature 006 and 005 overviews and implementation guidance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 Two features planned with care so bright,
Album views toggled left and right,
Stars to rate the photos gleam,
Together building feature dreams!
Documentation's path is clear,
Implementation starts from here! ✨

Pre-merge checks

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 4

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/specs/4-architecture/roadmap.md (1)
82-82: Update the roadmap timestamp to reflect today's changes.

Line 82 shows *Last updated: 2026-01-02* but Feature 005 and 006 were added on 2026-01-03. As per coding guidelines, the roadmap should be updated regularly to reflect feature status and progress.
🔎 Proposed fix
-*Last updated: 2026-01-02*
+*Last updated: 2026-01-03*

🧹 Nitpick comments (7)

docs/specs/4-architecture/features/006-photo-rating-filter/tasks.md (1)
364-364: Use "different from" instead of "different than".

Line 364 uses colloquial phrasing; per style guidelines, use "different from" for clarity.
- PhotosState store structure different than expected → may need refactoring
+ PhotosState store structure different from expected → may need refactoring
docs/specs/4-architecture/open-questions.md (1)
1604-1604: Update last-updated timestamp to match PR creation date.

The footer timestamp (2026-01-02) precedes the PR creation date (2026-01-03). Update to current date if new questions Q-007-01 through Q-007-06 were added in this PR.
- *Last updated: 2026-01-02*
+ *Last updated: 2026-01-03*
docs/specs/4-architecture/features/005-album-list-view/plan.md (1)

386-400: Scenario tracking is well-structured; verify scenarios are exhaustive against NFRs.

The Scenario Tracking table (lines 386-400) documents 10 scenarios that exercise the feature's key behaviors. However, ensure all NFR-005-* (non-functional requirement) criteria are covered by at least one scenario. For instance, NFR-005-02 (rendering performance for 100 albums < 300ms) appears only in exit criteria (line 432) but may not have an explicit scenario. Consider adding S-005-11 or similar for performance validation if not already covered.

Review the spec.md to confirm all NFR-005-* requirements have corresponding scenario coverage, and add explicit performance validation scenario if missing.

docs/specs/4-architecture/features/006-photo-rating-filter/spec.md (1)

52-53: Explicitly surface Feature 001 dependency in introduction.

Feature 006 depends on Feature 001 (Photo Star Rating) being complete. While this is documented in the Appendix (line 354), consider adding a dependency note in the Overview or Goals section so reviewers catch the blocking relationship immediately.

Also applies to: 354-357
docs/specs/4-architecture/features/006-photo-rating-filter/plan.md (2)
1-10: Consider adding intent-logging section documenting plan creation.

Per coding guidelines and learnings, plans should "capture prompt summaries, command sequences, and rationale…so downstream reviewers know how the change was produced." The current plan lacks a section documenting how the plan was created (e.g., prompts used, reasoning for increment sequencing, or AI-assisted generation notes). Consider adding an Appendix section (e.g., "Plan Creation Notes" or "Intent Log") that documents the planning process.

Also applies to: 96-113

51-75: Document Feature 001 dependency prominently.

Feature 006 depends on Feature 001 being complete (lines 62, 80). The plan acknowledges this in Assumptions and Risks, but it should be highlighted in the Dependencies & Interfaces section as a blocking dependency to prevent premature work allocation.

Consider restructuring the Dependencies section to separate "Blocking Dependencies" from optional ones, e.g.:
**Blocking Feature Dependencies:**
- **Feature 001 (Photo Star Rating):** Must be complete before starting Feature 006
  - Provides: user_rating field in PhotoResource
  - Verification: Confirm Feature 001 is deployed and user_rating field is accessible in UI layer
docs/specs/4-architecture/features/005-album-list-view/spec.md (1)

14-15: Clarify localStorage fallback behavior and error handling.

Line 39 states "If localStorage unavailable (private browsing), default to grid view without error." The implementation notes (lines 298-300) show the read logic but lack explicit error handling. Consider documenting:

What happens if localStorage.setItem() fails (write exception)

Whether a user notification is needed for private-browsing mode

How state remains consistent if localStorage read fails but the component renders

Also applies to: 288-301

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b64eb9 and aaec3ce.

📒 Files selected for processing (9)

docs/specs/4-architecture/features/005-album-list-view/plan.md
docs/specs/4-architecture/features/005-album-list-view/spec.md
docs/specs/4-architecture/features/005-album-list-view/tasks.md
docs/specs/4-architecture/features/006-photo-rating-filter/plan.md
docs/specs/4-architecture/features/006-photo-rating-filter/spec.md
docs/specs/4-architecture/features/006-photo-rating-filter/tasks.md
docs/specs/4-architecture/open-questions.md
docs/specs/4-architecture/roadmap.md
docs/specs/_current-session.md

🧰 Additional context used

📓 Path-based instructions (7)

**/*.md

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

**/*.md: Use Markdown format for documentation
At the bottom of documentation files, add an hr line followed by "Last updated: [date of the update]"

Files:

docs/specs/4-architecture/roadmap.md
docs/specs/4-architecture/features/006-photo-rating-filter/tasks.md
docs/specs/4-architecture/features/006-photo-rating-filter/spec.md
docs/specs/4-architecture/features/005-album-list-view/plan.md
docs/specs/4-architecture/open-questions.md
docs/specs/_current-session.md
docs/specs/4-architecture/features/005-album-list-view/spec.md
docs/specs/4-architecture/features/006-photo-rating-filter/plan.md
docs/specs/4-architecture/features/005-album-list-view/tasks.md

docs/specs/4-architecture/roadmap.md

📄 CodeRabbit inference engine (AGENTS.md)

docs/specs/4-architecture/roadmap.md: Update the roadmap regularly to reflect feature status and progress as work is made.
Keep high-level plans in docs/specs/4-architecture/roadmap.md, store each feature's spec/plan/tasks inside docs/specs/4-architecture/features/-/, and remove plans once work is complete.

Files:

docs/specs/4-architecture/roadmap.md

docs/specs/4-architecture/features/**/*.md

📄 CodeRabbit inference engine (AGENTS.md)

docs/specs/4-architecture/features/**/*.md: Author new specifications, feature plans, and task checklists using docs/specs/templates/feature-spec-template.md, docs/specs/templates/feature-plan-template.md, and docs/specs/templates/feature-tasks-template.md to keep structure, metadata, and verification notes uniform across features.
For any new UI feature or modification, include an ASCII mock-up in the specification (see docs/specs/4-architecture/spec-guidelines/ui-ascii-mockups.md).
When revising a specification, only document fallback or compatibility behaviour if the user explicitly asked for it; if instructions are unclear, pause and request confirmation instead of assuming a fallback.
For every task, refresh the relevant feature plan and note open questions; only move forward once the plan reflects the desired change. Update specs before code.
Update feature specs, feature plans, and tasks documents as progress is made and sync context to disk.
Capture prompt summaries, command sequences, and rationale in the active feature plan or an appendix referenced from it so downstream reviewers know how the change was produced (intent logging).
Track upcoming additions for contract tests, mutation analysis, and security/red-team prompt suites in the plans until automated jobs exist (quality gates).
Publish prompt and tool usage notes alongside the feature plan update so future agents understand how the iteration unfolded.

Files:

docs/specs/4-architecture/features/006-photo-rating-filter/tasks.md
docs/specs/4-architecture/features/006-photo-rating-filter/spec.md
docs/specs/4-architecture/features/005-album-list-view/plan.md
docs/specs/4-architecture/features/005-album-list-view/spec.md
docs/specs/4-architecture/features/006-photo-rating-filter/plan.md
docs/specs/4-architecture/features/005-album-list-view/tasks.md

docs/specs/4-architecture/features/**/{spec,plan,tasks}.md

📄 CodeRabbit inference engine (AGENTS.md)

docs/specs/4-architecture/features/**/{spec,plan,tasks}.md: Start every feature by updating or creating its specification at docs/specs/4-architecture/features/-/spec.md, followed by plan and tasks documents after clarifications are resolved.
Generate or refresh the feature plan only after the specification is current and high-/medium-impact clarifications are resolved and recorded in the spec (plus ADRs where required).

Files:

docs/specs/4-architecture/features/006-photo-rating-filter/tasks.md
docs/specs/4-architecture/features/006-photo-rating-filter/spec.md
docs/specs/4-architecture/features/005-album-list-view/plan.md
docs/specs/4-architecture/features/005-album-list-view/spec.md
docs/specs/4-architecture/features/006-photo-rating-filter/plan.md
docs/specs/4-architecture/features/005-album-list-view/tasks.md

docs/specs/4-architecture/features/**/tasks.md

📄 CodeRabbit inference engine (AGENTS.md)

docs/specs/4-architecture/features/**/tasks.md: Maintain a per-feature tasks checklist that mirrors the plan, orders tests before code, and keeps planned increments ≤90 minutes by preferring finer-grained entries and documenting sub-steps when something nears the limit.
Mark each task [x] in the feature's tasks.md as soon as it passes verification. Do not batch task completions—update the checklist after every individual task so progress is always visible.
Before committing, confirm every completed task in tasks.md is marked [x] and the roadmap status reflects current progress (validate task checklist).

Files:

docs/specs/4-architecture/features/006-photo-rating-filter/tasks.md
docs/specs/4-architecture/features/005-album-list-view/tasks.md

docs/specs/4-architecture/open-questions.md

📄 CodeRabbit inference engine (AGENTS.md)

docs/specs/4-architecture/open-questions.md: Capture every high-impact clarification question and each medium-impact uncertainty per feature in docs/specs/4-architecture/open-questions.md and, once resolved, record the outcome directly in the spec (requirements, NFR, behaviour/UI, telemetry/policy sections).
Log high- and medium-impact open questions in docs/specs/4-architecture/open-questions.md and remove each row as soon as it is resolved, ensuring the answer is captured first in the governing spec's normative sections.
Update or close entries in docs/specs/4-architecture/open-questions.md after completing work.

Files:

docs/specs/4-architecture/open-questions.md

docs/specs/_current-session.md

📄 CodeRabbit inference engine (AGENTS.md)

Maintain docs/specs/_current-session.md as the single live snapshot across active chats; always review/update it before closing a session.

Files:

docs/specs/_current-session.md

🧠 Learnings (24)

📓 Common learnings

Learnt from: CR
Repo: LycheeOrg/Lychee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-22T14:12:18.082Z
Learning: Applies to docs/specs/4-architecture/features/**/*.md : For any new UI feature or modification, include an ASCII mock-up in the specification (see docs/specs/4-architecture/spec-guidelines/ui-ascii-mockups.md).

Learnt from: CR
Repo: LycheeOrg/Lychee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-22T14:12:18.082Z
Learning: Feature ownership quick cues (Batch P3): Feature 009 covers operator console/UI docs, Feature 010 owns documentation & knowledge automation, Feature 011 governs AGENTS/runbooks/hooks, Feature 012 centralises core cryptography & persistence docs, and Feature 013 aggregates toolchain/quality automation guidance.

Learnt from: CR
Repo: LycheeOrg/Lychee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-22T14:12:18.082Z
Learning: Applies to docs/specs/4-architecture/features/**/*.md : Author new specifications, feature plans, and task checklists using docs/specs/templates/feature-spec-template.md, docs/specs/templates/feature-plan-template.md, and docs/specs/templates/feature-tasks-template.md to keep structure, metadata, and verification notes uniform across features.

Learnt from: CR
Repo: LycheeOrg/Lychee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-22T14:12:18.082Z
Learning: Applies to docs/specs/4-architecture/features/**/*.md : For every task, refresh the relevant feature plan and note open questions; only move forward once the plan reflects the desired change. Update specs before code.

Learnt from: CR
Repo: LycheeOrg/Lychee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-22T14:12:18.082Z
Learning: Applies to docs/specs/4-architecture/features/**/{spec,plan,tasks}.md : Generate or refresh the feature plan only after the specification is current and high-/medium-impact clarifications are resolved and recorded in the spec (plus ADRs where required).

Learnt from: CR
Repo: LycheeOrg/Lychee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-22T14:12:18.082Z
Learning: Applies to docs/specs/4-architecture/features/**/{spec,plan,tasks}.md : Start every feature by updating or creating its specification at docs/specs/4-architecture/features/<NNN>-<feature-name>/spec.md, followed by plan and tasks documents after clarifications are resolved.

Learnt from: CR
Repo: LycheeOrg/Lychee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-22T14:12:18.082Z
Learning: Applies to docs/specs/4-architecture/features/**/*.md : Capture prompt summaries, command sequences, and rationale in the active feature plan or an appendix referenced from it so downstream reviewers know how the change was produced (intent logging).