docs: 使用文档

liangjingkanji · Aug 4, 2023 · 1da20e5 · 1da20e5
1 parent 05c3164
commit 1da20e5
Show file tree

Hide file tree

Showing 13 changed files with 20 additions and 79 deletions.
diff --git a/docs/auto-page.md → docs/auto-pull.md b/docs/auto-page.md → docs/auto-pull.md
diff --git a/docs/config.md b/docs/config.md
@@ -48,7 +48,7 @@
 | setDebug | 是否输出网络日志, 和`LogRecordInterceptor`互不影响 |
 | setSSLCertificate | 配置Https证书 |
 | trustSSLCertificate | 信任所有Https证书 |
-| setConverter | [配置数据转换器](customizer-converter.md), 将网络返回的数据转换成你想要的数据结构 |
+| setConverter | [配置数据转换器](converter-customize.md), 将网络返回的数据转换成你想要的数据结构 |
 | setRequestInterceptor | [配置请求拦截器](interceptor.md), 适用于添加全局请求头/参数 |
 | setErrorHandler | [配置全局错误处理](error-global.md) |
 | setDialogFactory | [配置全局对话框](auto-dialog.md) |

diff --git a/docs/customizer-converter.md → docs/converter-customize.md b/docs/customizer-converter.md → docs/converter-customize.md
diff --git a/docs/convert-special.md → docs/converter-struct.md b/docs/convert-special.md → docs/converter-struct.md
diff --git a/docs/converter.md b/docs/converter.md
@@ -1,16 +1,16 @@
-Net支持请求返回的数据类型取决于你自己的转换器实现(即理论上支持返回任何对象):
+Net支持请求返回的数据类型取决于你自己的转换器实现
 
 # Get<任何对象>("path").await()
 
-如果不自定义转换器默认支持返回以下数据类型
+默认转换器支持返回以下数据类型
 
 | 函数 | 描述 |
 |-|-|
 | String | 字符串 |
 | ByteArray | 字节数组 |
-| ByteString | 内部定义的一种字符串对象 |
+| ByteString | 更多功能的字符串对象 |
 | File | 文件对象, 这种情况其实应当称为[下载文件](download-file.md) |
-| Response | 最基础的, 包含全部响应信息的对象(响应体/响应头/请求信息等) |
+| Response | 所有响应信息(响应体/响应头/请求信息等) |
 
 使用示例
 
@@ -20,10 +20,9 @@ scopeNetLife {
 }
 ```
 
-??? summary "
-默认使用的是: [NetConverter.DEFAULT](https://github.com/liangjingkanji/Net/blob/master/net/src/main/java/com/drake/net/convert/NetConverter.kt)"
-```kotlin
-interface NetConverter {
+??? example "转换器实现非常简单"
+    ```kotlin title="NetConverter.kt" linenums="1"
+    interface NetConverter {
 
         @Throws(Throwable::class)
         fun <R> onConvert(succeed: Type, response: Response): R?
@@ -48,4 +47,4 @@ interface NetConverter {
     }
     ```
 
-假设这里没有你需要的数据类型请[自定义转换器](/converter/#_3)(例如返回Json或Protocol)
+假设不支持你需要的数据类型, 例如JSON/ProtoBuf/Bitmap等请[自定义转换器](/converter/#_3)
diff --git a/docs/error-exception.md → docs/error-throws.md b/docs/error-exception.md → docs/error-throws.md
diff --git a/docs/error-default.md → docs/error.md b/docs/error-default.md → docs/error.md
@@ -12,7 +12,7 @@ Net具备完善的错误处理机制, 能捕获大部分网络请求或者异步
 
 如果捕获到错误默认会执行以下操作
 
--  `Logcat`中会输出详细的异常堆栈信息, 如果想要输出更详细内容请阅读[自定义异常](error-exception.md)
+-  `Logcat`中会输出详细的异常堆栈信息, 如果想要输出更详细内容请阅读[自定义异常](error-throws.md)
 -  `Toast`吐司错误异常信息, 如果想要自定义或者国际化错误文本请阅读[自定义错误提示](error-tip.md)
 
 <br>

diff --git a/docs/index.md b/docs/index.md
@@ -85,9 +85,10 @@ scopeNetLife {
 }
 ```
 
-详细查看[转换器](customizer-converter.md), 非以上类型要求[自定义转换器](customizer-converter.md)
+详细查看[转换器](converter.md), 非以上类型要求[自定义转换器](converter-customize.md)
 
 ---
 [下载Apk](https://github.com/liangjingkanji/Net/releases/latest/download/net-sample.apk){ .md-button }
 [下载源码](https://github.com/liangjingkanji/Net.git){ .md-button }
 [示例代码](https://github.com/liangjingkanji/Net/tree/master/sample/src/main/java/com/drake/net/sample/ui/fragment){ .md-button }
+[项目实战](https://github.com/liangjingkanji/Net/tree/master/sample/src/main/java/com/drake/net/sample/ui/fragment){ .md-button }
diff --git a/docs/read-cache.md b/docs/read-cache.md
diff --git a/docs/exception-track.md → docs/track.md b/docs/exception-track.md → docs/track.md
diff --git a/docs/updates.md b/docs/updates.md
@@ -241,7 +241,7 @@
 - 修复未知的TypeToken访问权限问题
 
 ## 3.0.6
-- 所有Json解析框架都可以解析`List<UserModel>`等嵌套泛型数据结构: [特殊结构解析](convert-special.md)
+- 所有Json解析框架都可以解析`List<UserModel>`等嵌套泛型数据结构
 
 ## 3.0.5
 - 修复Path编码问题

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -73,24 +73,24 @@ nav:
   - 全局配置: config.md
   - 请求结果:
       - 转换器: converter.md
-      - 自定义转换器: customizer-converter.md
-      - 自定义结构解析: convert-special.md
+      - 自定义转换器: converter-customize.md
+      - 自定义结构解析: converter-struct.md
       - Kotlin-Serialization: kotlin-serialization.md
       - 数据类生成插件: model-generate.md
   - 自动化:
       - 自动加载框: auto-dialog.md
       - 自动缺省页: auto-state.md
       - 自动下拉刷新: auto-refresh.md
-      - 自动分页加载: auto-page.md
+      - 自动分页加载: auto-pull.md
   - 切换线程: thread.md
   - ViewModel: view-model.md
-  - 异常追踪: exception-track.md
+  - 异常追踪: track.md
   - 错误处理:
-      - 默认错误处理: error-default.md
+      - 默认错误处理: error.md
       - 单例错误捕获: error-single.md
       - 全局错误捕获: error-global.md
       - 自定义错误提示: error-tip.md
-      - 自定义异常抛出: error-exception.md
+      - 自定义异常抛出: error-throws.md
   - OkHttpClient: okhttp-client.md
   - 拦截器: interceptor.md
   - Https证书: https.md

diff --git a/sample/proguard-rules.pro b/sample/proguard-rules.pro
@@ -1,5 +1,5 @@
 # Add project specific ProGuard rules here.
-# You can control the setKalle of applied configuration files using the
+# You can control the set of applied configuration files using the
 # proguardFiles setting in build.gradle.
 #
 # For more details, see