Skip to content

more docs#314

Merged
ildyria merged 1 commit into
masterfrom
more-documentation
Jul 2, 2026
Merged

more docs#314
ildyria merged 1 commit into
masterfrom
more-documentation

Conversation

@ildyria

@ildyria ildyria commented Jul 2, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Expanded and clarified FAQ answers, including album thumbnail sorting, login guidance, upload-folder protection, and Cloudflare IP handling.
    • Added detailed setup, troubleshooting, and behavior guides for facial recognition, Flow, Frame, RSS, slideshow, tagging, statistics, and user groups.
    • Updated feed and feature references to reflect current paths, settings, and visibility rules.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation content updated across FAQ, feature pages (facial recognition, flow, frame, rss, slideshow, tagging), general settings, and Supporter Edition pages (statistics, user groups). Changes expand explanations, add settings tables and troubleshooting guidance, update reference links/paths, and remove outdated content.

Changes

Documentation content updates

Layer / File(s) Summary
FAQ general updates
src/content/docs/docs/faq/general.md
Updated thumbnail settings anchor, api_key/session login link, upload URL protection options, Cloudflare proxy config path, and removed an outdated admin divider paragraph.
Facial recognition clustering and troubleshooting
src/content/docs/docs/features/facial-recognition.md
Extended clustering description with re-run behavior and added a Troubleshooting section covering settings, diagnostics, backlog, detection, clustering, overlays, selfie claims, and microservice issues.
Flow feature documentation expansion
src/content/docs/docs/features/flow.md
Expanded Flow overview, added ordering/opt-in strategy, NSFW handling, settings table, date format, and Supporter Edition features sections.
Frame feature documentation expansion
src/content/docs/docs/features/frame.md
Added Frame overview, access/entry-point behavior, settings table, and custom client building guidance via Photo::random endpoint.
RSS feed documentation expansion
src/content/docs/docs/features/rss.md, src/content/docs/docs/getting-started/settings.md
Rewrote RSS docs into how-it-works, accessing-the-feed, and settings sections; updated /feed endpoint wording in settings.md.
Slideshow documentation expansion
src/content/docs/docs/features/slideshow.md
Expanded how-it-works, starting-a-slideshow, and settings table sections.
Tagging documentation expansion
src/content/docs/docs/features/tagging.md
Expanded tag management, usage, tag albums, settings context, and Supporter Edition sections.
Supporter Edition statistics and user-groups documentation
src/content/docs/docs/se/statistics.md, src/content/docs/docs/se/user-groups.md
Replaced statistics documentation with Usage Statistics, Engagement Metrics, and Live Metrics sections plus settings table; updated user-groups documentation with how-it-works and group creation clarifications.

Estimated code review effort: 2 (Simple) | ~12 minutes

Poem

A rabbit hopped through pages of docs so fine,
Adding tables, tips, and settings in a line,
Flow, Frame, and RSS now clearly explained,
Troubleshooting hops where confusion once reigned,
🐇 Thumping happily, the docs now shine!

🚥 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.

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/content/docs/docs/features/facial-recognition.md (1)

195-200: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Clarify that reruns only touch unassigned faces.

The new troubleshooting step reads as if changing VISION_FACE_CLUSTER_EPS and rerunning clustering can repair any bad cluster, but the doc itself says already-assigned faces are left untouched. Add that caveat here so users do not expect this path to fix mislabeled people automatically.

Suggested addition
 - The `VISION_FACE_MODEL_NAME` (default `ArcFace`) recognition model determines embedding quality — a different model may produce more consistent embeddings for your photo set, but changing it does not retroactively update existing embeddings.
 - Poor detections (blurry, low-confidence, or partial faces — see above) produce noisy embeddings that cluster poorly; fixing detection quality often improves clustering as a side effect.
 - Clusters are only formed from faces not yet linked to a person; once a face is assigned to a person it's removed from the pool of unclustered faces.
+- If the wrong faces are already linked to a person, unassign them first; rerunning clustering only reprocesses unassigned faces.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 86bbf597-5e38-48a5-9390-d3cccef93b99

📥 Commits

Reviewing files that changed from the base of the PR and between bde9c1f and 63d02d2.

📒 Files selected for processing (10)
  • src/content/docs/docs/faq/general.md
  • src/content/docs/docs/features/facial-recognition.md
  • src/content/docs/docs/features/flow.md
  • src/content/docs/docs/features/frame.md
  • src/content/docs/docs/features/rss.md
  • src/content/docs/docs/features/slideshow.md
  • src/content/docs/docs/features/tagging.md
  • src/content/docs/docs/getting-started/settings.md
  • src/content/docs/docs/se/statistics.md
  • src/content/docs/docs/se/user-groups.md

Comment thread src/content/docs/docs/features/flow.md
@ildyria ildyria merged commit 2d6edc9 into master Jul 2, 2026
2 checks passed
@ildyria ildyria deleted the more-documentation branch July 2, 2026 14:19
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