Skip to content

docs: apply improvements to the navbar#675

Merged
tbouffard merged 1 commit intomainfrom
docs/website_display_gh_logo_instead_of_label
Feb 14, 2025
Merged

docs: apply improvements to the navbar#675
tbouffard merged 1 commit intomainfrom
docs/website_display_gh_logo_instead_of_label

Conversation

@tbouffard
Copy link
Member

@tbouffard tbouffard commented Feb 13, 2025 •
edited
Loading

Use the GitHub logo instead of a label for the link to the GitHub repository to make the right-hand side more attractive (logos only).
Hide the navigation bar when scrolling to free up screen space for reading.

Also improved the footer: “Built with Docusaurus” is now a link to the docusaurus website, to advertise this tool.

Notes

Former display

maxgraph_website_0.15.1.webm

New display

maxgraph_website_PR_675.webm

Summary by CodeRabbit

  • New Features

    • Navigation bar now dynamically adjusts its visibility during scrolling.
    • Improved labeling enhances accessibility for navigation elements.
    • Footer content has been updated with refined formatting and a direct reference.

  • Style

    • Header icon design has been refined, with adjustments for both light and dark themes for a consistent visual experience.

@tbouffard
docs: apply improvements to the navbar
0ce7fb1 
Use the GitHub logo instead of a label for the link to the GitHub repository to make the right-hand side more attractive (logos only).
Hide the navigation bar when scrolling to free up screen space for reading.

Also improved the footer: “Built with Docusaurus” is now a link to the docusaurus website, to advertise this tool.
@tbouffard tbouffard added the documentation Improvements or additions to documentation label Feb 13, 2025
@coderabbitai
Copy link

coderabbitai bot commented Feb 13, 2025 •
edited
Loading

Walkthrough

This pull request modifies the website's configuration and styles. In the Docusaurus configuration file, a new hideOnScroll property is added to the navbar, the GitHub link’s label is replaced with an aria-label, and a new class name (header-github-link) is applied. The footer copyright text is updated with an HTML line break and a Docusaurus link. Additionally, new CSS rules are introduced for the GitHub icon in the header, including a dark theme variant to ensure proper display.

Changes

File Summary
packages/website/docusaurus.config.ts Added hideOnScroll to the navbar; replaced GitHub link label with an aria-label and added a header-github-link class; updated footer copyright text.
packages/website/src/css/custom.css Added CSS rules for the .header-github-link:before pseudo-element with an SVG background; provided a dark theme variant for the GitHub icon styling.

Possibly related PRs

Suggested labels

chore

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 13, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

coderabbitai[bot]
coderabbitai bot reviewed Feb 13, 2025
View reviewed changes
Copy link

@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: 0

🧹 Nitpick comments (1)
packages/website/src/css/custom.css (1)

32-45: LGTM! Consider extracting SVG data URLs.

The implementation is well-structured with proper dark mode support. However, the SVG data URLs make the CSS less maintainable.

Consider extracting the SVG data URLs to separate files:

-.header-github-link:before {
+.header-github-link:before {
   content: '';
   width: 24px;
   height: 24px;
   display: flex;
-  background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
+  background: url('/img/github.svg')
   no-repeat;
 }

-html[data-theme='dark'] .header-github-link:before {
-  background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
+html[data-theme='dark'] .header-github-link:before {
+  background: url('/img/github-dark.svg')
   no-repeat;
 }

This would improve maintainability and reduce the CSS file size. The SVGs can be optimized using tools like SVGO.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 721bdd4 and 0ce7fb1.

📒 Files selected for processing (2)
  • packages/website/docusaurus.config.ts (3 hunks)
  • packages/website/src/css/custom.css (1 hunks)
🔇 Additional comments (3)
packages/website/docusaurus.config.ts (3)

84-84: LGTM! Good UX improvement.

The hideOnScroll feature will help maximize screen space for content reading, improving the overall user experience.

111-116: LGTM! Good accessibility practice.

The changes maintain accessibility while improving visual appeal:

  • Using aria-label ensures screen readers can still identify the GitHub link
  • The header-github-link class will be used to style the GitHub icon

168-168: LGTM! Good security practice.

The Docusaurus link implementation includes proper security attributes:

  • target="_blank" for opening in new tab
  • rel="noopener noreferrer" to prevent security vulnerabilities

@tbouffard tbouffard merged commit f325b04 into main Feb 14, 2025
4 checks passed
@tbouffard tbouffard deleted the docs/website_display_gh_logo_instead_of_label branch February 14, 2025 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@tbouffard