openzim / openzim/devdocs

Introduce dark mode

Open
#20 3 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

Do we want to implement a dark mode just like devdocs.io is supporting? (not sure how all readers are passing the appropriate info, maybe worth to PoC if it is complex to implement in scraper)

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

Start by reviewing how the Python scraper passes information to readers and compare the dark-mode behavior supported by devdocs.io. Investigate whether the required reader information can be carried through the scraper, then validate the approach with a proof of concept. Done means there is a demonstrated, workable path for implementing dark mode.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.