[Task] <In the Documentation Contribution Guidelines, add the Documentation Writing Guidelines>
Open
discussion
doc
good first issue
- Dominant language
- Java
- Stars
- 7.4k
- Forks
- 1.3k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 32
Description
### Description
Nowadays, there is no standardization of document writing, we can use [Docs]https://github.com/ruanyf/document-style-guide] as a guide to standardize the use of documents.
@tomsun28 @zhangshenghang @zqr10159, how do you think?
### Task List
_No response_
Contributor guide
Research direction
No file, test, or documentation entry point is named. Locate the Documentation Contribution Guidelines, review the linked documentation style guide, and determine how its writing guidance should be incorporated; done means the contribution guidelines include the agreed writing standards.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100