Skip to content

Conversation

JakeSCahill
Copy link
Contributor

This pull request includes changes to simplify and optimize the handling of navigation styles and announcement bar logic. The most important updates involve restructuring CSS for better responsiveness, removing unused helper functions, and cleaning up the announcement bar template.

CSS Improvements:

  • Updated the @media query in src/css/nav.css to simplify responsive styles for .nav-container and removed redundant definitions. ([[1]](https://github.com/redpanda-data/docs-ui/pull/318/files#diff-e2542659752e2de8d97af993968c93866ae25445a996b39dc55a22e71a352989L55-R60), [[2]](https://github.com/redpanda-data/docs-ui/pull/318/files#diff-e2542659752e2de8d97af993968c93866ae25445a996b39dc55a22e71a352989L113-L117))

Announcement Bar Logic Simplification:

  • Removed the get-module-announcement helper function from src/helpers/get-module-announcement.js, as it is no longer used. ([src/helpers/get-module-announcement.jsL1-L30](https://github.com/redpanda-data/docs-ui/pull/318/files#diff-ebf7129a94a14e68a70a0241ab73ae35c950713c4ce0bcc14f3363627643b525L1-L30))
  • Simplified the src/partials/announcement-bar.hbs template by removing references to get-module-announcement and restructuring the logic for displaying announcements. ([src/partials/announcement-bar.hbsL1-L20](https://github.com/redpanda-data/docs-ui/pull/318/files#diff-9a8a6aea2db50056df305477e671e7fd52453840a40bb7506370550565cb7730L1-L20))

Copy link

netlify bot commented Jul 28, 2025

Deploy Preview for docs-ui ready!

Name Link
🔨 Latest commit 83d65df
🔍 Latest deploy log https://app.netlify.com/projects/docs-ui/deploys/68874f6bd880390008322301
😎 Deploy Preview https://deploy-preview-318--docs-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Jul 28, 2025

📝 Walkthrough

Walkthrough

This change removes module-level announcement support from the codebase. The helper file responsible for extracting module-specific announcement data (get-module-announcement.js) is deleted. The Handlebars template for the announcement bar (announcement-bar.hbs) is refactored to eliminate logic and conditions related to module announcements, simplifying the rendering flow to only consider page, component-version, and site-level announcements. Additionally, the navigation CSS is updated to consolidate and clarify responsive styling for .nav-container by broadening and simplifying the relevant media queries.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Page
    participant AnnouncementBar

    User->>Page: Load page
    Page->>AnnouncementBar: Render with context (page, component-version, site)
    alt Page-level announcement exists
        AnnouncementBar->>User: Show page-level announcement
    else Component-version-level announcement exists
        AnnouncementBar->>User: Show component-version-level announcement
    else Site-level announcement exists
        AnnouncementBar->>User: Show site-level announcement
    else
        AnnouncementBar->>User: No announcement shown
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • kbatuigas

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6b02320 and 83d65df.

📒 Files selected for processing (3)
  • src/css/nav.css (1 hunks)
  • src/helpers/get-module-announcement.js (0 hunks)
  • src/partials/announcement-bar.hbs (1 hunks)
💤 Files with no reviewable changes (1)
  • src/helpers/get-module-announcement.js
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
🔇 Additional comments (5)
src/partials/announcement-bar.hbs (3)

1-1: LGTM: Clean removal of module announcement logic.

The conditional has been appropriately simplified to remove the reference to the deleted get-module-announcement helper while maintaining the existing page, component-version, and site-level announcement functionality.


3-3: Good: Updated data-announcement-key to reflect simplified logic.

The data attribute correctly removes the module-specific key option, aligning with the removal of module-level announcements.


7-9: Excellent: Added link existence checks to prevent empty anchor tags.

The conditional checks for announcement-link, announcement-link, and announcementLink before rendering anchor tags is a defensive programming practice that prevents broken or empty links from being rendered.

Also applies to: 12-14, 17-19

src/css/nav.css (2)

55-60: LGTM: Media query consolidation improves responsive design.

The expansion from a narrow range (769px-1023px) to a broader max-width (1023px) consolidates the navigation container styling and eliminates redundant CSS declarations. The explicit setting of width: var(--nav-width) and the top position calculation that includes var(--announcement-bar-height) properly accounts for the simplified announcement bar logic.


58-58: Good: Top position correctly accounts for announcement bar height.

The calculation calc(var(--navbar-height) + var(--announcement-bar-height)) ensures proper spacing for the navigation container, which aligns with the simplified announcement bar implementation that still needs to reserve vertical space.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-nav

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@JakeSCahill JakeSCahill requested a review from paulohtb6 July 28, 2025 10:22
@JakeSCahill JakeSCahill merged commit eb3ee6d into main Jul 28, 2025
6 checks passed
@JakeSCahill JakeSCahill deleted the fix-nav branch July 28, 2025 14:16
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