rmax/scrapy-redis

[docs] Chinese documentation

Open

#243 opened on Apr 5, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5,337 stars) (1,586 forks)batch import
documentationgood first issuehelp wanted

Description

Description

We have a great amount of Chinese users and developers, I think add Chinese documentation is necessary, it could help us gain more community support. For now, I will use readthedocs on my fork of this repo for Chinese documentation. Suggestions are welcome!

Tasks

  • Chinese documentation

Contributor guide

Tech stack
pythonredis
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Chinese language fluencybasic knowledge of Sphinx or readthedocs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Start by reviewing the existing English documentation in the repository to understand the content structure. Then create a plan to translate the documentation into Chinese, possibly using a fork and readthedocs for hosting. Look at how other projects handle multilingual documentation with Sphinx, and consider leveraging translation tools or community contributions. The issue mentions using readthedocs, so setting that up and providing a translation of the main README and API docs would be a good first step.