Skip to content

Fix missing favicon.ico in offline documentation #4214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed

Conversation

Prthmsh7
Copy link

@Prthmsh7 Prthmsh7 commented Apr 2, 2025

Fixes #4003

This PR addresses the issue #4003 by explicitly ensuring that the favicon.ico file is properly copied to the root of the offline documentation directory. The fix adds code to the tools/chmgen.d file to specifically handle the favicon.ico file. Basically the changes are:

  1. Modified tools/chmgen.d to add explicit code that copies the favicon.ico file to the offline documentation root directory.
  2. Added a changelog entry to document this fix.

@Prthmsh7 Prthmsh7 requested a review from CyberShadow as a code owner April 2, 2025 08:17
@dlang-bot
Copy link
Contributor

Thanks for your pull request and interest in making D better, @Prthmsh7! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please verify that your PR follows this checklist:

  • My PR is fully covered with tests (you can see the coverage diff by visiting the details link of the codecov check)
  • My PR is as minimal as possible (smaller, focused PRs are easier to review than big ones)
  • I have provided a detailed rationale explaining my changes
  • New or modified functions have Ddoc comments (with Params: and Returns:)

Please see CONTRIBUTING.md for more information.


If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment.

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

Copy link
Member

@CyberShadow CyberShadow left a comment

Choose a reason for hiding this comment

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

Thank you for the fix!

chmgen.d is only used to generate a .chm file. It is not used for building the HTML documentation described in #4003.

I am not sure if .chm files can have an icon. Have you tested this patch and confirmed that it is a user-visible change? If so, it would be helpful to understand the details.

We also use changelog entries for high-visibility changes with a significant user impact. As I don't believe a favicon fix falls in that category, you can delete the changelog entry file.

@CyberShadow
Copy link
Member

@Prthmsh7

Thank you for submitting this pull request. After further review of these changes, it appears they are nonsensical, clearly generated using an LLM or similar automated tool, and have obviously not been tested by a human. The PR does not solve any real problem and instead wastes valuable time for our maintainers and reviewers.

Please ensure that any changes submitted to this project are manually tested by a human being to confirm they solve an actual, identified issue. If you wish to use automated tools (such as language models or AI-assisted code generators), please clearly disclose this up front and discuss your approach with the project maintainers/community before submitting a PR. You can find a list of contact points for the community on the language's website.

Submitting auto-generated, unverified code without appropriate disclosure shows disrespect for the maintainers' time and reduces the quality of contributions to the project. We greatly appreciate your future cooperation in maintaining a collaborative and effective contribution process.

@Prthmsh7
Copy link
Author

Prthmsh7 commented Apr 2, 2025

@Prthmsh7

Thank you for submitting this pull request. After further review of these changes, it appears they are nonsensical, clearly generated using an LLM or similar automated tool, and have obviously not been tested by a human. The PR does not solve any real problem and instead wastes valuable time for our maintainers and reviewers.

Please ensure that any changes submitted to this project are manually tested by a human being to confirm they solve an actual, identified issue. If you wish to use automated tools (such as language models or AI-assisted code generators), please clearly disclose this up front and discuss your approach with the project maintainers/community before submitting a PR. You can find a list of contact points for the community on the language's website.

Submitting auto-generated, unverified code without appropriate disclosure shows disrespect for the maintainers' time and reduces the quality of contributions to the project. We greatly appreciate your future cooperation in maintaining a collaborative and effective contribution process.

I'm really sorry if I made any mistake. I'll take a note to not use any LLM references in the future contributions.

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.

favicon.ico file missing in offline documentation
3 participants