Closed zhoujinsong closed 3 months ago
The following sections, which are version-independent, will be split and maintained in a separate project on the official website:
The structure of the documentation will be adjusted as follows:
@zhoujinsong Contributing part is simple, I remember there was a document for the community-developed spec[1], I think it should be added to help new developers contribute faster.
[1] : https://docs.google.com/document/d/1Pwv1LflW3z5yq34qDpEYwSxOB3LIE5qoKQ_5Sv0IV1Y
Search before asking
What would you like to be improved?
User documentation is one of the important means for users to understand and learn how to use a project.
The current user documentation of Arctic has the following shortcomings:
To address the above issues, we will optimize the documentation as follows:
How should we improve?
We will complete the documentation optimization task through the following steps:
It is worth noting that maintaining both English and Chinese documentation at the same time will bring a heavy workload. After this optimization, we will only keep the English documentation as the only language for continuous follow-up.
Are you willing to submit PR?
Subtasks
No response
Code of Conduct