Repository navigation
feat: add illustrated user guides and Google Takeout walkthrough - #87
Merged
Merged
Conversation
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (41)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe change adds a documentation section to the website, with an index, individual guides, site navigation, and styling. The guides cover installation, everyday features, library management, privacy, providers, add-ons, and troubleshooting. The change also adds an MIT License text file. ChangesWebsite documentation
License text
Priority: ➖ Normal Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Merge Risk: ⚪ Minimal · up to The documentation change is mergeable after normal checks; no actionable issue remains identified. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
2 of 8 tasks
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="src/content/guides/downloads.md" line_range="14-16" />
<code_context>
+3. On desktop, allow time for any required managed tools to download. OpenTubeX uses yt-dlp and FFmpeg for download tasks; tool options depend on your platform.
+
+<picture>
+ <source data-shot-theme="dark" media="(prefers-color-scheme: dark)" srcset="/docs-images/download-settings-dark.webp" type="image/webp" />
+ <source data-shot-theme="light" media="(prefers-color-scheme: light)" srcset="/docs-images/download-settings-light.webp" type="image/webp" />
+ <img src="/docs-images/download-settings-light.webp" alt="Downloads settings showing Enable Downloads, Download Folder, concurrent downloads, and bandwidth limit." width="1232" height="820" loading="lazy" decoding="async" />
+</picture>
+
</code_context>
<issue_to_address>
**issue (broader_impact):** The guides reference `/docs-images/...` assets, but no files under `public/docs-images` are added by this diff. Every illustrated OpenTubeX screenshot therefore requests a missing URL and renders as a broken image.
**Suggested fix:** Add the referenced image files under `public/docs-images` (including both theme variants and the Takeout images), or update the paths to the location where those assets are actually committed.
</issue_to_address>
### Comment 2
<location path="src/content/guides/downloads.md" line_range="14-15" />
<code_context>
+3. On desktop, allow time for any required managed tools to download. OpenTubeX uses yt-dlp and FFmpeg for download tasks; tool options depend on your platform.
+
+<picture>
+ <source data-shot-theme="dark" media="(prefers-color-scheme: dark)" srcset="/docs-images/download-settings-dark.webp" type="image/webp" />
+ <source data-shot-theme="light" media="(prefers-color-scheme: light)" srcset="/docs-images/download-settings-light.webp" type="image/webp" />
+ <img src="/docs-images/download-settings-light.webp" alt="Downloads settings showing Enable Downloads, Download Folder, concurrent downloads, and bandwidth limit." width="1232" height="820" loading="lazy" decoding="async" />
+</picture>
</code_context>
<issue_to_address>
**issue (bug_risk):** The screenshot variant is selected with `prefers-color-scheme`, which follows the operating-system preference rather than OpenTubeX's selected website theme. Choosing Dark or Light in the site's theme control while the OS uses the opposite theme leaves the guides showing the wrong screenshot variant.
**Triggers:** When the user explicitly selects a theme that differs from the operating-system color scheme.
**Suggested fix:** Drive the picture source selection from the same `data-theme`/theme state used by the site, updating the active source when the theme selector changes instead of relying only on `prefers-color-scheme`.
</issue_to_address>Sourcery assessment
Approval pending. 2 findings to address first.
Blocking findings: src/content/guides/downloads.md:16, src/content/guides/downloads.md:15
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
All reported issues were addressed across 44 files
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Member
Author
|
@coderabbitai review |
✅ Action performedReview finished.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Users need setup instructions and help with everyday tasks beyond the website’s feature overview. Add a Docs section with 12 linked guides, step-by-step instructions, and screenshots.
Resolves #82. Follow-up documentation maintenance rule: OpenTubeX/OpenTubeX#1507.
Validation: 21 tests passed; offline production build passed after rebasing onto the Starlight cleanup. Browser checks covered all 12 guides, 243 internal links, three viewport widths, image loading/fullscreen, theme switching, and mobile navigation.
Implemented with GPT-6 in the Codex harness.