openzim / openzim/devdocs

Stop using online resources

Open
#21 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Godot, and possibly other documentation references images that are hotlinked from the Internet that won't work offline.

This is consistent with the experience you'd get with DevDocs in offline mode, but is a poor overall experience.

The scraper should download these images and serve them from the Zim (possibly also caching them to S3).

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 tracing the scraper entry point responsible for Godot and other documentation references, then inspect how assets are currently represented in the ZIM. Determine how remote images can be downloaded and served locally, and whether S3 caching is in scope. Done means offline users can view the referenced images without depending on the Internet.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.