skywind3000 / skywind3000/PyStand

文档拉胯

Open
#104 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
1.2k
Forks
146
PR merge metrics
No merged PRs in 30d

Description

用了这么久 PyStand,性能很好但不怎么火,感觉很奇怪

应该是文档的问题吧,我看 issue 里挺多关于使用的问题的,文档能更详细一些就好了。还有就是没有英文文档,可能导致这个项目传不到外面去。

作者有重写文档的想法吗?我看这个项目有一阵子没动了……

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 the existing PyStand documentation and the usage-related issues referenced in the report. Identify which user questions are currently unanswered and define the scope for more detailed documentation and an English version. Done means the agreed documentation gaps are covered in both the existing and English documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
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.