Skip to content

Comments

Improve documentation#281

Merged
ildyria merged 2 commits intomasterfrom
docs
Feb 22, 2026
Merged

Improve documentation#281
ildyria merged 2 commits intomasterfrom
docs

Conversation

@ildyria
Copy link
Member

@ildyria ildyria commented Feb 22, 2026

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide for mass-importing photos via the command-line (with Docker usage example), including practical examples.
    • Describes recursive import behavior that creates albums for folders/subfolders and an "import" album in Docker contexts.
    • Lists available import options with defaults and warns about delete-related options; recommends checking help before running.
    • Explains how to move imported photos between albums via the web interface.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 22, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Added a new FAQ subsection documenting mass photo import via the lychee:sync CLI, with examples (including Docker), option descriptions and defaults, recursive import behavior creating albums for folders/subfolders, and cautions about delete-related options.

Changes

Cohort / File(s) Summary
FAQ Documentation
docs/faq_general.md
Added a new "How to mass import photos?" subsection describing php artisan lychee:sync /path/to/import usage (example with album_id), Docker example (docker exec ...), recursive import behavior (albums for folders/subfolders, default "import" album in Docker), full list of lychee:sync options with defaults (album_id, owner_id, resync_metadata, delete_imported, import_via_symlink, skip_duplicates, delete_missing_photos, delete_missing_albums, dry_run), and cautions about delete-related options and using --help.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through docs to clear the way,
A sync command to brighten your day.
Docker, folders, albums in flight,
Photos find homes by morning light. 📸

🚥 Pre-merge checks | ✅ 1
✅ 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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (1)
docs/faq_general.md (1)

13-47: New section duplicates the existing "Can I set up Lychee to watch a folder…" entry

Line 238 already covers lychee:sync /path/to/import and the --album_id variant with identical examples. Consider either removing the overlap from the existing entry or converting it to a cross-reference (See "How to mass import photos?" above.) to avoid keeping the two in sync going forward.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@ildyria ildyria merged commit aa7a45c into master Feb 22, 2026
1 of 2 checks passed
@ildyria ildyria deleted the docs branch February 22, 2026 19:46
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