You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I have searched in the issues and found no similar issues.
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:
No English documentation is provided, which limits the user group.
There is no distinction between versions, which makes it difficult for users of previous versions to find the content they need.
The documentation directory is not split reasonably, making it difficult for users to quickly find the content they want.
To address the above issues, we will optimize the documentation as follows:
Provide an English version of the documentation.
Split version-related and unrelated content for separate management.
Optimize the directory structure.
How should we improve?
We will complete the documentation optimization task through the following steps:
Split version-related and version-unrelated content. Version-unrelated content will be managed in a separate project on the official website, while version-related content will still be managed together with the main project.
Rearrange the document directory structure.
Supplement and translate the existing documentation into English.
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.
@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.
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
The text was updated successfully, but these errors were encountered: