Skip to content

Feature: Added documentation, README, playwright timeout#21

Merged
hgosalia merged 1 commit into
mainfrom
features/add-docs
May 28, 2026
Merged

Feature: Added documentation, README, playwright timeout#21
hgosalia merged 1 commit into
mainfrom
features/add-docs

Conversation

@hgosalia
Copy link
Copy Markdown
Member

No description provided.

@github-actions
Copy link
Copy Markdown

📋 PR Summary

Title: Feature: Added documentation, README, playwright timeout
Author: @hgosalia
Draft: No
11 files changed: +308 additions, -169 deletions

Description

This PR introduces several enhancements to the application's documentation and user experience. The README has been updated to clarify the initial setup process and streamline the instructions for adding photos, while additional documentation files have been created to detail the application's architecture, data storage mechanisms, demo modes, keyboard shortcuts, persistence strategies, and tile caching. These changes aim to improve user understanding and accessibility of the application features. Furthermore, the timeout for Playwright tests has been increased from 30 seconds to 60 seconds, which will enhance the reliability of automated testing by allowing more time for tests to complete. Overall, these updates provide clearer guidance for users and developers alike, enhancing the overall usability of the application.

Files

  • README.md — Updated (+14/-167)
  • docs/architecture.md — New file (+41 lines)
  • docs/data-storage.md — New file (+15 lines)
  • docs/demo-mode.md — New file (+24 lines)
  • docs/keyboard-shortcuts.md — New file (+30 lines)
  • docs/persistence.md — New file (+27 lines)
  • docs/testing.md — New file (+62 lines)
  • docs/tile-caching.md — New file (+53 lines)
  • docs/tips.md — New file (+41 lines)
  • sw.js — +0/-1
  • tests/playwright.config.js — +1/-1

@hgosalia hgosalia merged commit 0e3f5c5 into main May 28, 2026
1 check passed
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.

1 participant