openzim / openzim/overview

Consider supporting readthedocs

Open
#45 8 comments 0 reactions 4 assignees View on GitHub

@rgaudin is already working on this.

Since Dec 12, 2024.

enhancement question
Dominant language
HTML
Stars
9
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Currently, we use the free Community plan of readthedocs.com

readthedocs is becoming an important cornerstone of our documentation since we've already published libzim, libkiwix, zim-tools and python-scraperlib documentation there, and we plan to add more. I think we could / should even publish all scrapers documentation there rather than using the crappy Github wiki.

The free Community plan is mostly sufficient except that Ads are displayed throughout our documentation, see e.g. https://python-scraperlib.readthedocs.io/en/latest/

For 5$ per month, we could remove these adds and give support to readthedocs.

Image

See https://about.readthedocs.com/pricing/#/community

Given the moderate monthly price plus the fact that it is important that we also give back to teams we like, I think that we should move to this plan.

WDYT?

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.