openzim / openzim/devdocs

Add icon to navigation tree

Open
#17 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
9
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Icon on the first item of the navigation tree is missing

In the ZIM

image

Online

image

DevDocs compiles these into a spritesheet that has a nondeterministic name so it's not easy to pull just the icon we want out, but it might be possible to grab the whole sheet. The icons are also available in the DevDocs repo: https://github.com/freeCodeCamp/devdocs/tree/main/public/icons/docs, but there's no license information for the icons which may differ from the content.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No source file or test is named. Start by tracing how the scraper builds the navigation tree and handles icons, then compare the ZIM and online screenshots and inspect the referenced DevDocs icons; done means the first navigation item displays the intended icon with an acceptable, documented source.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.