3.9K Star 22.5K Fork 7.8K

GVPdromara / hutool

 / 详情

【6.x】【讨论】文档重构与优化

已完成
成员
创建于  
2022-06-18 22:53

基于很多朋友们反馈,决定单独开一个issue 讨论 文档的完善与重构

预期计划重构开始时间为6.x发布以后

目前对文档的想法:

SEO方面

大家经常反馈搜一个方法不好搜,搜不到

目前仍在选型

https://vuepress-theme-reco.recoluan.com/
https://doc.xugaoyi.com/
(暂定) https://vuepress-theme-hope.github.io/v2/zh/
https://vitepress.vuejs.org/

https://docs.github.com/cn/

搜索引擎有algolia提供的docsearch或者主题自带
申请地址:https://docsearch.algolia.com/apply/

现有文档方面

  1. 补充test,很多工具方法缺单元测试,文档也可以指路到单元测试地址,鼓励大家根据单测学习代码,同时还能节省一定维护成本,单测也尽量注释完备
  2. 维护wiki库,很多hutool无法实现和封装的功能,如何使用第三方库替代,一些工具类的设计思想和注意事项,甚至一些小技巧或者结合多个工具实现某些具体功能
  3. 欢迎大家讨论补充

评论 (19)

阿超 创建了任务
阿超 添加了
 
enhancement
标签
展开全部操作日志

大佬,6.0大概啥时候上线啊

顶起!

建议hutool组织内部成立官方的测试审核群体, 毕竟个人开发者水平各不相同, 无法统一才是常态.有了官方测试员审核, 可以保证测试代码的质量有一个下限.
wiki库可以作为凝结hutool开发者的核心. 包括但不限于

  • hutool入门指南,将每个文档内提到或没有提到的各种方法在对应场景下使用至少一次, 达到看到即懂的状态.(即什么情况下用到当前方法才是最优解)
  • 而第三方库的实现属于高级功能, 可以放到wiki后半部分.
  • wiki里面还可以讲解一下重构后的vuepress文档如何搭建如何更新等.(可以增加维护者数量)
  • 甚至还可以介绍一下在QQ群里聊天的规则.(纯小白聊天指南,有时候技术问题会演变成人身攻击,提供规则可以限制危险升级的可能.)
  • 甚至为其它讲解hutool工具的博客, 学习网站, 视频课程等提供引流.(双赢)
阿超 修改了描述
阿超 修改了描述
阿超 修改了描述
阿超 修改了描述

昨天晚上做了一个梦。梦见 Hutool工具升级到了6.0 项目名字变了。变成了一个ga开头的名字,还很长。
我看了一下,说,哎。好好的名字为啥要改呢。改也行。到是改一个更短,更好记忆的呀。这是改的什么乱七八糟的呀。
今天赶快看一下,幸好还没升级6.0 :laughing:

maybe Gaslighting :trollface: :+1:

这么奇幻吗 :smile:

阿超 负责人设置为阿超

暂定的就是最强的 vuepress-theme-hope

6.0啥时候上线呢?

快啦

好的,正好要开新项目了,我想要最新版本~ 哈哈

期待

Looly 添加了
 
feature
标签
Looly 移除了
 
enhancement
标签

mybatis-plus 这个版本开始兼容jdk17了,hutool6.x 开始兼容了吗

    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.2.7-SNAPSHOT</version>
    </dependency>
Looly 任务状态待办的 修改为已完成

登录 后才可以发表评论

状态
负责人
里程碑
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
参与者(14)
7413431 vampireachao 1613450829 1463 loolly admin 1578914022 105129 kihcrjwq admin 1678015218 5045796 wandaren 1578979107 3040392 appleofgray 1586265491 2036294 bigfireyzs 1578964768 5580798 itwalking 1601427639 1178989 yangyxd 1578945196 1682265 fy520fy 1635848685 1330286 kirno7 1640936232
加载更多
Java
1
https://gitee.com/dromara/hutool.git
git@gitee.com:dromara/hutool.git
dromara
hutool
hutool

搜索帮助