Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📚 Reverse the rewrite of OpenIM-Docs #384

Open
2 tasks done
cubxxw opened this issue May 11, 2023 · 2 comments
Open
2 tasks done

📚 Reverse the rewrite of OpenIM-Docs #384

cubxxw opened this issue May 11, 2023 · 2 comments
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. openim User information, template information, important information, never expired and closed.
Milestone

Comments

@cubxxw
Copy link
Contributor

cubxxw commented May 11, 2023

Checklist

  • I've searched for similar issues and couldn't find anything matching
  • I've discussed this feature request in the OpenIMSDK Slack and got positive feedback

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

  • Good documentation allows more developers to get involved.
  • Good documentation design makes it easier for users to get started.
  • Good documentation design can make or break a top open source project

Potential Drawbacks

It takes time~

Additional Information

@cubxxw cubxxw added kind/documentation Categorizes issue or PR as related to documentation. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. labels May 11, 2023
@cubxxw cubxxw pinned this issue May 11, 2023
@cubxxw cubxxw added this to the 365 milestone May 25, 2023
@kubbot
Copy link
Member

kubbot commented Jul 25, 2023

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 kubbot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 25, 2023
@cubxxw cubxxw added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Aug 2, 2023
@kubbot
Copy link
Member

kubbot commented Aug 2, 2023

This issue is available for anyone to work on. Make sure to reference this issue in your pull request. ✨ Thank you for your contribution! ✨
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 kubbot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 2, 2023
@cubxxw cubxxw added the openim User information, template information, important information, never expired and closed. label Sep 9, 2023
@cubxxw cubxxw changed the title [Feature]: Reverse the rewrite of OpenIM-Docs 📚 Reverse the rewrite of OpenIM-Docs Sep 9, 2023
@cubxxw cubxxw modified the milestones: v3.1, v3.4 Sep 28, 2023
@skiffer-git skiffer-git unpinned this issue Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. openim User information, template information, important information, never expired and closed.
Projects
Status: In progress
Development

No branches or pull requests

2 participants