Skip to content

fix(docs): Replaced favicon with transparent icon (#446)#451

Merged
rahulharpal1603 merged 1 commit intoAOSSIE-Org:mainfrom
ssz2605:fix/docs-favicon
Jul 6, 2025
Merged

fix(docs): Replaced favicon with transparent icon (#446)#451
rahulharpal1603 merged 1 commit intoAOSSIE-Org:mainfrom
ssz2605:fix/docs-favicon

Conversation

@ssz2605
Copy link
Contributor

@ssz2605 ssz2605 commented Jul 6, 2025

Replaced the docs site favicon with a transparent version of the PictoPy icon.

  • Used icon.png from frontend/src-tauri/icons/
  • Renamed it to favicon.png and placed it in docs/assets/
  • Updated mkdocs.yml to reference the new icon

Fixes #446

image

Summary by CodeRabbit

  • Style
    • Updated the logo and favicon images used in the site theme.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 6, 2025

Walkthrough

The mkdocs.yml configuration file was updated to change the paths for the site's logo and favicon from assets/PictoPy-logo.png to assets/favicon.png. No other files or settings were modified.

Changes

File(s) Change Summary
mkdocs.yml Updated theme configuration to use new logo and favicon image paths (assets/favicon.png).

Assessment against linked issues

Objective Addressed Explanation
Update docs website icon to remove white background and use icon from frontend/src-tauri/icons (#446)

Poem

A favicon hop, a logo swap,
Now docs look crisp, no white to crop!
The bunny’s proud, the site’s refined,
With icons neat and well-aligned.
🐇✨

Mkdocs smiles, the job is done—
A polished site for everyone!


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 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.

Copy link
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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 996f288 and 7dbdcdd.

📒 Files selected for processing (1)
  • mkdocs.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Tauri Tests

Comment on lines +8 to +9
logo: assets/favicon.png
favicon: assets/favicon.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Logo & favicon now point to the same 32×32-style asset—double-check visual quality

Switching the logo reference from the full-sized PictoPy-logo.png to the (typically small) favicon.png may cause the top-left site brand to look pixelated or off-center.
Unless the new PNG was exported at logo-grade resolution, keep the original logo and change only the favicon.

-  logo: assets/favicon.png
-  favicon: assets/favicon.png
+  # keep high-resolution logo, use transparent favicon only for the tab icon
+  logo: assets/PictoPy-logo.png
+  favicon: assets/favicon.png

🏁 Script executed:

#!/bin/bash
# 1. Ensure the high-res logo still exists
fd PictoPy-logo.png docs || echo "⚠️  PictoPy-logo.png missing"

# 2. Check for other references that still expect the old logo path
rg -n 'PictoPy-logo\.png' -A1 -B1

# 3. Confirm the new favicon actually landed in the expected location
fd favicon.png docs/assets || echo "⚠️  favicon.png missing in docs/assets"

Length of output: 290


Restore high-resolution logo and retain favicon for the tab icon

We’ve confirmed that docs/assets/PictoPy-logo.png still exists and docs/assets/favicon.png is in place. To preserve branding quality, switch only the favicon reference and keep the original logo:

• File: mkdocs.yml (lines 8–9)

-  logo: assets/favicon.png
-  favicon: assets/favicon.png
+  logo: assets/PictoPy-logo.png
+  favicon: assets/favicon.png
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
logo: assets/favicon.png
favicon: assets/favicon.png
logo: assets/PictoPy-logo.png
favicon: assets/favicon.png
🤖 Prompt for AI Agents
In mkdocs.yml around lines 8 to 9, the logo is currently set to a low-resolution
favicon image. Change the logo path back to docs/assets/PictoPy-logo.png to
restore the high-resolution logo, while keeping the favicon path as
docs/assets/favicon.png to retain the tab icon.

@ssz2605
Copy link
Contributor Author

ssz2605 commented Jul 6, 2025

@rahulharpal1603 I have fixed this issue kindly review.

@rahulharpal1603
Copy link
Contributor

Hi, can you reduce the space between the logo and the "PictoPy" text?

@ssz2605
Copy link
Contributor Author

ssz2605 commented Jul 6, 2025

image

Is this okay

@rahulharpal1603
Copy link
Contributor

image

Is this okay

A little more

@ssz2605
Copy link
Contributor Author

ssz2605 commented Jul 6, 2025

image

@rahulharpal1603 Is this much gap okay? I also increased the logo size slightly, as I felt it looked a bit small. But if you'd prefer the original size, I can revert it — just let me know.

@rahulharpal1603
Copy link
Contributor

rahulharpal1603 commented Jul 6, 2025

Hi @ssz2605, I accidentally merged this PR. After merging this PR, I realised that you have not added the new image file in your commits.

So, I have reverted this PR. Please open another PR for this issue.

@rahulharpal1603 rahulharpal1603 merged commit e37412a into AOSSIE-Org:main Jul 6, 2025
5 checks passed
@ssz2605
Copy link
Contributor Author

ssz2605 commented Jul 6, 2025

@rahulharpal1603 sure I will make a new PR with the latest changes .

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.

BUG: Remove white background from the app icon in docs website.

2 participants