openimsdk / open-im-server

IM Chat
https://openim.io
Apache License 2.0
13.9k stars 2.44k forks source link

📚 Reverse the rewrite of OpenIM-Docs #384

Closed cubxxw closed 1 month ago

cubxxw commented 1 year ago

Checklist

Is this feature request related to a problem?

No

Problem Description

Just the address of our OpenIM documentation

It's very problematic, it doesn't look standard, and our documentation needs a lot of work, which this Feature will do.

Solution Description

I think you can use either vuepress2.0 or hugo templates to refactor the OpenIMSDK documentation, but I actually prefer Hugo.

We need to do an RFC proposal for the overall design of the document. We need to optimize the content of the document, the directory structure, the specification, and the parts of the highlights section, the search section.

We even need to provide bilingual support in Chinese and English.

Benefits

Potential Drawbacks

It takes time~

Additional Information

kubbot commented 1 year ago

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

kubbot commented 1 year ago

This issue is available for anyone to work on. Make sure to reference this issue in your pull request. :sparkles: Thank you for your contribution! :sparkles: Join slack 🤖 to connect and communicate with our developers. If you wish to accept this assignment, please leave a comment in the comments section: /accept.🎯