Skip to content

Conversation

@elibosley
Copy link
Member

@elibosley elibosley commented Nov 3, 2025

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • Bug Fixes

    • Refined iframe display rules to show only essential navigation elements and preserve back-button styling.
  • Chores

    • Simplified sidebar visibility logic for embedded views and removed related layout adjustments.
    • Enhanced theme normalization behavior.
  • Documentation

    • Updated embedding docs and examples to remove the sidebar query parameter and related session-storage guidance.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 3, 2025

Warning

Rate limit exceeded

@elibosley has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 5 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between e45189f and 6636742.

📒 Files selected for processing (2)
  • .github/workflows/pr.yml (3 hunks)
  • embedding.md (2 hunks)
📝 Walkthrough
📝 Walkthrough

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description contains only a generic contributor checklist with no actual description of the changes, objectives, or rationale for the modifications. Add a meaningful description explaining what was changed (CSS simplification, sidebar logic removal, theme normalization function) and why these changes improve iframe support.
✅ Passed checks (1 passed)
Check name Status Explanation
Title check ✅ Passed The title 'refactor: simplify iframe styling and remove sidebar visibility logic' clearly and specifically summarizes the main changes in the PR, accurately reflecting both the CSS simplification and the removal of sidebar-related logic across multiple files.

Comment @coderabbitai help to get the list of available commands and usage tips.

elibosley and others added 2 commits November 3, 2025 16:12
- Eliminated the `sidebar` parameter from the iframe configuration details and related examples in the documentation.
- Updated the `buildDocsUrl` function to reflect this change, simplifying the URL construction process.
- Adjusted related guidance to focus on essential parameters for iframe usage.
@elibosley elibosley changed the title feat: better iframe support refactor: simplify iframe styling and remove sidebar visibility logic Nov 3, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

PR Preview Action v1.6.2

🚀 View preview at
https://unraid.github.io/docs/pr-preview/pr-371/

Built to branch gh-pages at 2025-11-03 21:33 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

- Introduced a new optional query parameter `lang=<locale>` for setting the initial Docs language in the iframe.
- Updated the `buildDocsUrl` function to accommodate the new language parameter, ensuring generated URLs reflect the selected locale.
- Adjusted documentation to clarify the usage of the new language option.
- Removed the `lang` parameter and replaced it with `locale` for better clarity in setting the initial Docs language.
- Introduced a new function, `prefixLocale`, to handle locale-specific URL construction.
- Updated the `buildDocsUrl` function to utilize the new locale handling, ensuring URLs reflect the desired language segment.
- Revised documentation to clarify the usage of the locale parameter and its impact on the iframe experience.
- Simplified the conditions for running jobs in the PR workflow by removing specific event types for `pull_request`.
- Adjusted the checkout action to use the full repository name and reference from the pull request context.
- Ensured lint fixes are pushed to the correct branch reference based on the pull request context.
@elibosley elibosley merged commit e401416 into main Nov 3, 2025
@elibosley elibosley deleted the feat/iframe-enhancements branch November 3, 2025 21:26
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.

2 participants