search

openimsdk / open-im-server

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

Docs: Creation of OpenIM Community Documentation #666

Closed cubxxw closed 1 month ago

cubxxw commented 1 year ago

Issue Overview

To assist others in quickly and comprehensively understanding OpenIM, we need to create a thorough community documentation. This documentation will provide essential information to novices, contributors, and collaborators, including but not limited to product features, project structure, contribution guidelines, and community code of conduct.

Related Tasks

  1. Refer to the structure and content of Kubernetes community documentation, and create the OpenIM community documentation based on this model.
  2. Use Hugo for web development and choose a suitable theme to optimize user experience.
  3. Ensure that the documentation structure is clear, the content comprehensive, and is easy to search and navigate.

Action Items

  1. Choose and set up a suitable Hugo theme.
  2. Create the basic structure of the documentation, including but not limited to the following sections: Introduction, Quick Start Guide, User Guide, API Documentation, Contribution Guide, Community Code of Conduct, Developer Guide, FAQ, Changelog, and Contact Information.
  3. Based on the Kubernetes community documentation, gradually fill in relevant content about OpenIM.
  4. Review and test the documentation to ensure all links and content are working properly.

Expected Outcome

Upon completion, we will have a complete, easy-to-understand OpenIM community documentation that can help users, contributors, and collaborators to quickly and comprehensively understand OpenIM.

Reference Resources

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.🎯

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.

cubxxw commented 1 year ago

openim.io https://github.com.openim/website Link: #1103

kubbot commented 11 months 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 8 months ago

This issue was closed because it has been stalled for 7 days with no activity.

kubbot commented 5 months 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.