Skip to content

Fix broken docs links #1075

Open
PranjaliBhardwaj wants to merge 2 commits into
AOSSIE-Org:mainfrom
PranjaliBhardwaj:broken-doc-fix
Open

Fix broken docs links #1075
PranjaliBhardwaj wants to merge 2 commits into
AOSSIE-Org:mainfrom
PranjaliBhardwaj:broken-doc-fix

Conversation

@PranjaliBhardwaj
Copy link
Copy Markdown

@PranjaliBhardwaj PranjaliBhardwaj commented Jan 25, 2026

Issue: #1074

Summary of changes:

  1. docs/frontend/gallery-view.md
    Describes the main gallery: grid layout, date grouping, filtering.
    Lists components (ChronologicalGallery, ImageCard, MediaView, ImageViewer, MediaThumbnails, MediaInfoPanel, etc.).
    Cross-links to Screenshots, State Management, and UI Components.
  2. docs/frontend/ui-components.md
    ShadCN-style primitives: table of button, card, dialog, input, badge, avatar, sidebar, etc., and app-specific bits (404, ErrorPage, LoadingScreen, Icons, PaginationControls).
    Feature components: Media, Navigation, OnboardingSteps, Dialog, Loader, EmptyStates, FolderPicker, ThemeToggle, Timeline, Updater, VideoPlayer, WebCam.
    Short “Related documentation” section linking to Gallery View, State Management, and Screenshots.
  3. mkdocs.yml
    Under Frontend, nav updated to:
    UI Components → frontend/ui-components.md
    Gallery View → frontend/gallery-view.md
    State Management → frontend/state-management.md
    Screenshots → frontend/screenshots.md
    docs/index.md already points to ./frontend/ui-components and ./frontend/gallery-view. Those targets exist now, so the links work. No change was made to docs/index.md.

Summary by CodeRabbit

  • Documentation
    • Added a Gallery View guide covering layout, behavior, responsive grid, date grouping, filtering, thumbnails with overlays, and screenshots.
    • Added a UI Components architecture guide outlining primitives, feature components, styling approach, and component organization for reuse.
    • Updated site navigation to surface the new frontend reference guides.

Review Change Stack

Signed-off-by: Pranjali Bhardwaj <pranjalisharma6543@gmail.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 3a4fe237-f8eb-4791-81f8-a719eebd5a50

📥 Commits

Reviewing files that changed from the base of the PR and between 37f9510 and ab2c492.

📒 Files selected for processing (1)
  • docs/frontend/ui-components.md
✅ Files skipped from review due to trivial changes (1)
  • docs/frontend/ui-components.md

Walkthrough

Adds two frontend documentation pages (Gallery View, UI Components) and updates MkDocs navigation to expose them under the Frontend section; total additions across docs and mkdocs: 125 lines.

Changes

Frontend Documentation

Layer / File(s) Summary
Docs pages and navigation
docs/frontend/gallery-view.md, docs/frontend/ui-components.md, mkdocs.yml
Adds Gallery View and UI Components documentation pages and updates MkDocs navigation to include both under the Frontend section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • AOSSIE-Org/PictoPy#515: Directly conflicts with this PR by removing the same documentation files and reverting mkdocs navigation changes.

Suggested labels

Documentation

Suggested reviewers

  • rahulharpal1603

Poem

🐰 I hopped through lines of docs with cheer,
Two pages placed for frontend folks to hear,
Nav updated, pages ready to view,
A tidy change — small, helpful, and true!

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'Fix broken docs links' accurately summarizes the main objective of the PR, which is to fix broken documentation links by adding missing documentation files (gallery-view.md and ui-components.md) and updating the MkDocs navigation.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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
Copy Markdown
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: 1

🤖 Fix all issues with AI agents
In `@docs/frontend/ui-components.md`:
- Around line 1-88: The ShadCN-style primitives table is missing the Slider
component used by the media player; add a new row for Slider in the primitives
table (ShadCN-style primitives section) listing `Slider` as the component and a
short role like "Range slider / media seek control" so the docs reflect the
actual primitive used by NetflixStylePlayer; ensure the name matches the Slider
component symbol used in the codebase.

Comment thread docs/frontend/ui-components.md
@rohan-pandeyy rohan-pandeyy added the documentation Improvements or additions to documentation label May 22, 2026
@github-actions
Copy link
Copy Markdown
Contributor

⚠️ This PR has merge conflicts.

Please resolve the merge conflicts before review.

Your PR will only be reviewed by a maintainer after all conflicts have been resolved.

📺 Watch this video to understand why conflicts occur and how to resolve them:
https://www.youtube.com/watch?v=Sqsz1-o7nXk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation PR has merge conflicts

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants