taichi-dev/taichi

[doc] Review & proofread the current documentation

Open

#941 opened on May 10, 2020

View on GitHub
 (1 comment) (2 reactions) (1 assignee)C++ (28,195 stars) (2,384 forks)batch import
docenhancementgood first issue

Description

@yuanming-hu As you mentioned in https://github.com/taichi-dev/taichi-docs-zh-cn/pull/17#issuecomment-626218425, just open an issue to track in case that you forgot this.

Contributor guide

Tech stack
pythoncpp
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Basic understanding of Taichi
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Review the current documentation in the docs/ directory. The issue references a comment from PR #17 in the Chinese documentation repo, so check that PR for context. Identify any outdated or unclear sections and propose changes. Since the issue is old, verify that the documentation hasn't been updated already.