Skip to content
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

Replace default DevDocs illustration by specific language logo #29

Open
Popolechien opened this issue Sep 27, 2024 · 8 comments
Open

Replace default DevDocs illustration by specific language logo #29

Popolechien opened this issue Sep 27, 2024 · 8 comments
Labels
enhancement New feature or request
Milestone

Comments

@Popolechien
Copy link

Devdocs has the corresponding logos, and seeing how we are likely to end up with dozen up dozen of zim files, it might be helpful to help visually distinguish (beside the zim title, obviously)
Screenshot 2024-09-27 at 13 51 16

@Popolechien Popolechien added the enhancement New feature or request label Sep 27, 2024
@kelson42
Copy link

Very supportive of this request. Sounds like a detail, but is not.

@benoit74 benoit74 changed the title Add language logos to zim file favicon Replace default DevDocs illustration by specific language logo Sep 28, 2024
@benoit74
Copy link
Contributor

To rephrase this a bit, the feature request is: "would it be possible to automatically use the specific icon used in devdocs for the given slug as ZIM illustration, instead the default DevDocs illustration".

@benoit74
Copy link
Contributor

Quick answer seems to be this is not really possible, the logo displayed on devdocs is way too small. We need a 48x48px, logo is 16x16px, if we upscale it, it is going to be ugly. And placing a 16x16px logo in the middle of a 48x48px (without upscaling, using only 16x16px is going to be weird since it leaves lots of free space).

Logos are probably also at https://github.com/freeCodeCamp/devdocs/tree/main/public/icons/docs

Here we can find the source where the logo was originally retrieved.

I'm afraid this will have to be manually setup for every recipe in the farm.

@benoit74
Copy link
Contributor

Note that implementing #32 will be needed before one can customize the illustration in the Zimfarm

@benoit74
Copy link
Contributor

benoit74 commented Oct 3, 2024

One idea we've just add is that we can probably automate the creation of a composite icon based on existing ones.

We can have a "generic" icon with a placeholder for the 16x16 icons available at https://github.com/freeCodeCamp/devdocs/blob/main/public/icons/docs/

Generic Icon:
Image

Sample result for Angular:
Image

@siemsie do you have any input / feedback / design suggestion to make the icons look better? (we can chat about this on Slack, not sure it is easy to jump into it without context ^^)

@benoit74
Copy link
Contributor

After discussing with @siemsie, we realized there is "only" about 205 icons to create, and it looks like it is totally feasible to create and update them manually and would allow to be more independent from devdocs.

So we will give it a try, and must hence implement #32 first, and we can probably live with the default devdocs illustration otherwise.

@benoit74
Copy link
Contributor

benoit74 commented Nov 1, 2024

Closing this issue for now, we plan to go with #32 only for now (custom icons created "by hand"). Can always be reopened if we change our minds.

@benoit74 benoit74 closed this as not planned Won't fix, can't repro, duplicate, stale Nov 1, 2024
@benoit74
Copy link
Contributor

benoit74 commented Nov 1, 2024

Reopening, because it has also been proposed in #8, so maybe we should consider it. Anyway, not a priority from my PoV.

@benoit74 benoit74 reopened this Nov 1, 2024
@benoit74 benoit74 added this to the later milestone Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants