From bdbb1dfe224bbb8b5e68c512687092eec8a4114f Mon Sep 17 00:00:00 2001
From: feijie <feijie89@qq.com>
Date: Wed, 11 Dec 2024 10:11:57 +0800
Subject: [PATCH] =?UTF-8?q?feat(docs):=20=E6=B7=BB=E5=8A=A0Account?=
 =?UTF-8?q?=E6=A8=A1=E5=9D=97=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../README.EN.md                              | 60 ++++++++++++++
 .../README.md                                 | 60 ++++++++++++++
 .../README.EN.md                              | 83 +++++++++++++++++++
 .../LINGYUN.Abp.Account.Application/README.md | 83 +++++++++++++++++++
 .../LINGYUN.Abp.Account.HttpApi/README.EN.md  | 59 +++++++++++++
 .../LINGYUN.Abp.Account.HttpApi/README.md     | 59 +++++++++++++
 .../README.EN.md                              | 58 +++++++++++++
 .../LINGYUN.Abp.Account.Templates/README.md   | 58 +++++++++++++
 8 files changed, 520 insertions(+)
 create mode 100644 aspnet-core/modules/account/LINGYUN.Abp.Account.Application.Contracts/README.EN.md
 create mode 100644 aspnet-core/modules/account/LINGYUN.Abp.Account.Application.Contracts/README.md
 create mode 100644 aspnet-core/modules/account/LINGYUN.Abp.Account.Application/README.EN.md
 create mode 100644 aspnet-core/modules/account/LINGYUN.Abp.Account.Application/README.md
 create mode 100644 aspnet-core/modules/account/LINGYUN.Abp.Account.HttpApi/README.EN.md
 create mode 100644 aspnet-core/modules/account/LINGYUN.Abp.Account.HttpApi/README.md
 create mode 100644 aspnet-core/modules/account/LINGYUN.Abp.Account.Templates/README.EN.md
 create mode 100644 aspnet-core/modules/account/LINGYUN.Abp.Account.Templates/README.md

diff --git a/aspnet-core/modules/account/LINGYUN.Abp.Account.Application.Contracts/README.EN.md b/aspnet-core/modules/account/LINGYUN.Abp.Account.Application.Contracts/README.EN.md
new file mode 100644
index 000000000..df472b950
--- /dev/null
+++ b/aspnet-core/modules/account/LINGYUN.Abp.Account.Application.Contracts/README.EN.md
@@ -0,0 +1,60 @@
+# LINGYUN.Abp.Account.Application.Contracts
+
+Application service contracts for the ABP account module, providing interface definitions for account management.
+
+[简体中文](./README.md)
+
+## Features
+
+* Phone number registration
+* WeChat Mini Program registration
+* Password reset via phone number
+* Phone verification code functionality (registration, login, password reset)
+* Email verification code login
+* User profile management
+* User session management
+* Two-factor authentication
+* User claims management
+
+## Module Dependencies
+
+```csharp
+[DependsOn(typeof(AbpAccountApplicationContractsModule))]
+public class YouProjectModule : AbpModule
+{
+  // other
+}
+```
+
+## Service Interfaces
+
+### IAccountAppService
+
+Account management service interface, providing:
+* Phone number registration
+* WeChat Mini Program registration
+* Password reset via phone number
+* Send phone verification codes (registration, login, password reset)
+* Send email verification codes (login)
+
+### IMyProfileAppService
+
+Profile management service interface, providing:
+* Get/Update personal profile
+* Change password
+* Change phone number
+* Change avatar
+* Two-factor authentication management
+* Get/Verify authenticator
+* Get recovery codes
+
+### IMyClaimAppService
+
+User claims management service interface, providing:
+* Get user claims
+* Update user claims
+
+## Localization
+
+The module includes multi-language support, with resource files located at:
+* `/LINGYUN/Abp/Account/Localization/Resources`
diff --git a/aspnet-core/modules/account/LINGYUN.Abp.Account.Application.Contracts/README.md b/aspnet-core/modules/account/LINGYUN.Abp.Account.Application.Contracts/README.md
new file mode 100644
index 000000000..fdc72adf8
--- /dev/null
+++ b/aspnet-core/modules/account/LINGYUN.Abp.Account.Application.Contracts/README.md
@@ -0,0 +1,60 @@
+# LINGYUN.Abp.Account.Application.Contracts
+
+ABP账户模块的应用服务契约，提供账户管理相关的接口定义。
+
+[English](./README.EN.md)
+
+## 功能特性
+
+* 手机号注册账户
+* 微信小程序注册账户
+* 手机号重置密码
+* 手机验证码功能（注册、登录、重置密码）
+* 邮箱验证码登录
+* 用户个人资料管理
+* 用户会话管理
+* 双因素认证
+* 用户声明管理
+
+## 模块引用
+
+```csharp
+[DependsOn(typeof(AbpAccountApplicationContractsModule))]
+public class YouProjectModule : AbpModule
+{
+  // other
+}
+```
+
+## 接口服务
+
+### IAccountAppService
+
+账户管理服务接口，提供以下功能：
+* 手机号注册
+* 微信小程序注册
+* 手机号重置密码
+* 发送手机验证码（注册、登录、重置密码）
+* 发送邮箱验证码（登录）
+
+### IMyProfileAppService
+
+个人资料管理服务接口，提供以下功能：
+* 获取/更新个人资料
+* 更改密码
+* 更改手机号
+* 更改头像
+* 双因素认证管理
+* 获取/验证认证器
+* 获取恢复代码
+
+### IMyClaimAppService
+
+用户声明管理服务接口，提供以下功能：
+* 获取用户声明
+* 更新用户声明
+
+## 本地化
+
+模块包含多语言支持，资源文件位于：
+* `/LINGYUN/Abp/Account/Localization/Resources`
diff --git a/aspnet-core/modules/account/LINGYUN.Abp.Account.Application/README.EN.md b/aspnet-core/modules/account/LINGYUN.Abp.Account.Application/README.EN.md
new file mode 100644
index 000000000..b48f683ac
--- /dev/null
+++ b/aspnet-core/modules/account/LINGYUN.Abp.Account.Application/README.EN.md
@@ -0,0 +1,83 @@
+# LINGYUN.Abp.Account.Application
+
+Implementation of ABP account module application services, providing complete account management functionality.
+
+[简体中文](./README.md)
+
+## Features
+
+* Account Management Service Implementation
+  * Phone number registration
+  * WeChat Mini Program registration
+  * Password reset
+  * Verification code sending (SMS, Email)
+* Profile Management
+  * Basic information maintenance
+  * Password modification
+  * Phone number change
+  * Avatar update
+  * Two-factor authentication
+* User Claims Management
+* Email Services
+  * Email confirmation
+  * Email verification
+* SMS Services
+  * Verification code sending
+* WeChat Mini Program Integration
+* Virtual File System Support
+
+## Module Dependencies
+
+```csharp
+[DependsOn(
+    typeof(AbpAccountApplicationModule),
+    typeof(AbpAccountApplicationContractsModule),
+    typeof(AbpAccountTemplatesModule),
+    typeof(AbpIdentityDomainModule),
+    typeof(AbpWeChatMiniProgramModule))]
+public class YouProjectModule : AbpModule
+{
+  // other
+}
+```
+
+## Application Services
+
+### AccountAppService
+
+Implements `IAccountAppService` interface, providing:
+* User registration (phone number, WeChat Mini Program)
+* Password reset
+* Verification code sending
+
+### MyProfileAppService
+
+Implements `IMyProfileAppService` interface, providing:
+* Profile management
+* Password modification
+* Phone number change
+* Avatar update
+* Two-factor authentication management
+
+### MyClaimAppService
+
+Implements `IMyClaimAppService` interface, providing:
+* User claims management
+
+## Email Services
+
+Provides the following email services:
+* `IAccountEmailConfirmSender` - Email confirmation service
+* `IAccountEmailVerifySender` - Email verification service
+* `AccountEmailSender` - Email sending implementation
+
+## SMS Services
+
+Provides the following SMS services:
+* `IAccountSmsSecurityCodeSender` - SMS verification code sending service
+* `AccountSmsSecurityCodeSender` - SMS verification code sending implementation
+
+## URL Configuration
+
+The module pre-configures the following URLs:
+* EmailConfirm - Email confirmation URL, defaults to "Account/EmailConfirm"
diff --git a/aspnet-core/modules/account/LINGYUN.Abp.Account.Application/README.md b/aspnet-core/modules/account/LINGYUN.Abp.Account.Application/README.md
new file mode 100644
index 000000000..c6fc50aa6
--- /dev/null
+++ b/aspnet-core/modules/account/LINGYUN.Abp.Account.Application/README.md
@@ -0,0 +1,83 @@
+# LINGYUN.Abp.Account.Application
+
+ABP账户模块的应用服务实现，提供完整的账户管理功能实现。
+
+[English](./README.EN.md)
+
+## 功能特性
+
+* 账户管理服务实现
+  * 手机号注册
+  * 微信小程序注册
+  * 密码重置
+  * 验证码发送（短信、邮件）
+* 个人资料管理
+  * 基本信息维护
+  * 密码修改
+  * 手机号变更
+  * 头像更新
+  * 双因素认证
+* 用户声明管理
+* 邮件服务
+  * 邮件确认
+  * 邮件验证
+* 短信服务
+  * 验证码发送
+* 微信小程序集成
+* 虚拟文件系统支持
+
+## 模块引用
+
+```csharp
+[DependsOn(
+    typeof(AbpAccountApplicationModule),
+    typeof(AbpAccountApplicationContractsModule),
+    typeof(AbpAccountTemplatesModule),
+    typeof(AbpIdentityDomainModule),
+    typeof(AbpWeChatMiniProgramModule))]
+public class YouProjectModule : AbpModule
+{
+  // other
+}
+```
+
+## 应用服务
+
+### AccountAppService
+
+实现`IAccountAppService`接口，提供：
+* 用户注册（手机号、微信小程序）
+* 密码重置
+* 验证码发送
+
+### MyProfileAppService
+
+实现`IMyProfileAppService`接口，提供：
+* 个人资料管理
+* 密码修改
+* 手机号变更
+* 头像更新
+* 双因素认证管理
+
+### MyClaimAppService
+
+实现`IMyClaimAppService`接口，提供：
+* 用户声明管理
+
+## 邮件服务
+
+提供以下邮件服务：
+* `IAccountEmailConfirmSender` - 邮件确认服务
+* `IAccountEmailVerifySender` - 邮件验证服务
+* `AccountEmailSender` - 邮件发送实现
+
+## 短信服务
+
+提供以下短信服务：
+* `IAccountSmsSecurityCodeSender` - 短信验证码发送服务
+* `AccountSmsSecurityCodeSender` - 短信验证码发送实现
+
+## URL配置
+
+模块预配置了以下URL：
+* EmailConfirm - 邮件确认URL，默认为"Account/EmailConfirm"
diff --git a/aspnet-core/modules/account/LINGYUN.Abp.Account.HttpApi/README.EN.md b/aspnet-core/modules/account/LINGYUN.Abp.Account.HttpApi/README.EN.md
new file mode 100644
index 000000000..77e73c4be
--- /dev/null
+++ b/aspnet-core/modules/account/LINGYUN.Abp.Account.HttpApi/README.EN.md
@@ -0,0 +1,59 @@
+# LINGYUN.Abp.Account.HttpApi
+
+The HTTP API layer of the ABP account module, providing RESTful API implementations.
+
+[简体中文](./README.md)
+
+## Features
+
+* Provides HTTP API endpoints for account management
+* Supports localization and multi-language
+* Integrates with ABP MVC framework
+* Automatic API controller registration
+
+## Module Dependencies
+
+```csharp
+[DependsOn(
+    typeof(AbpAccountHttpApiModule),
+    typeof(AbpAccountApplicationContractsModule))]
+public class YouProjectModule : AbpModule
+{
+  // other
+}
+```
+
+## API Controllers
+
+### AccountController
+
+Provides the following HTTP API endpoints:
+* POST /api/account/register - Register with phone number
+* POST /api/account/register-by-wechat - Register with WeChat Mini Program
+* POST /api/account/reset-password - Reset password
+* POST /api/account/send-phone-register-code - Send phone registration verification code
+* POST /api/account/send-phone-signin-code - Send phone login verification code
+* POST /api/account/send-email-signin-code - Send email login verification code
+* POST /api/account/send-phone-reset-password-code - Send phone password reset verification code
+
+### MyProfileController
+
+Provides the following HTTP API endpoints:
+* GET /api/account/my-profile - Get personal profile
+* PUT /api/account/my-profile - Update personal profile
+* POST /api/account/my-profile/change-password - Change password
+* POST /api/account/my-profile/change-phone-number - Change phone number
+* POST /api/account/my-profile/send-phone-number-change-code - Send phone number change verification code
+* POST /api/account/my-profile/change-avatar - Update avatar
+
+### MyClaimController
+
+Provides the following HTTP API endpoints:
+* GET /api/account/my-claim - Get user claims
+* PUT /api/account/my-claim - Update user claims
+
+## Localization Configuration
+
+The module pre-configures localization options:
+* Supports AccountResource localization
+* Automatically registers MVC application parts
diff --git a/aspnet-core/modules/account/LINGYUN.Abp.Account.HttpApi/README.md b/aspnet-core/modules/account/LINGYUN.Abp.Account.HttpApi/README.md
new file mode 100644
index 000000000..1b3606425
--- /dev/null
+++ b/aspnet-core/modules/account/LINGYUN.Abp.Account.HttpApi/README.md
@@ -0,0 +1,59 @@
+# LINGYUN.Abp.Account.HttpApi
+
+ABP账户模块的HTTP API层，提供RESTful API接口实现。
+
+[English](./README.EN.md)
+
+## 功能特性
+
+* 提供账户管理的HTTP API接口
+* 支持本地化和多语言
+* 集成ABP MVC框架
+* 自动API控制器注册
+
+## 模块引用
+
+```csharp
+[DependsOn(
+    typeof(AbpAccountHttpApiModule),
+    typeof(AbpAccountApplicationContractsModule))]
+public class YouProjectModule : AbpModule
+{
+  // other
+}
+```
+
+## API控制器
+
+### AccountController
+
+提供以下HTTP API端点：
+* POST /api/account/register - 手机号注册
+* POST /api/account/register-by-wechat - 微信小程序注册
+* POST /api/account/reset-password - 重置密码
+* POST /api/account/send-phone-register-code - 发送手机注册验证码
+* POST /api/account/send-phone-signin-code - 发送手机登录验证码
+* POST /api/account/send-email-signin-code - 发送邮箱登录验证码
+* POST /api/account/send-phone-reset-password-code - 发送手机重置密码验证码
+
+### MyProfileController
+
+提供以下HTTP API端点：
+* GET /api/account/my-profile - 获取个人资料
+* PUT /api/account/my-profile - 更新个人资料
+* POST /api/account/my-profile/change-password - 修改密码
+* POST /api/account/my-profile/change-phone-number - 修改手机号
+* POST /api/account/my-profile/send-phone-number-change-code - 发送手机号变更验证码
+* POST /api/account/my-profile/change-avatar - 更新头像
+
+### MyClaimController
+
+提供以下HTTP API端点：
+* GET /api/account/my-claim - 获取用户声明
+* PUT /api/account/my-claim - 更新用户声明
+
+## 本地化配置
+
+模块预配置了本地化选项：
+* 支持AccountResource资源本地化
+* 自动注册MVC应用程序部件
diff --git a/aspnet-core/modules/account/LINGYUN.Abp.Account.Templates/README.EN.md b/aspnet-core/modules/account/LINGYUN.Abp.Account.Templates/README.EN.md
new file mode 100644
index 000000000..78c7f6153
--- /dev/null
+++ b/aspnet-core/modules/account/LINGYUN.Abp.Account.Templates/README.EN.md
@@ -0,0 +1,58 @@
+# LINGYUN.Abp.Account.Templates
+
+Email template definition module for the ABP account module, providing account-related email template functionality.
+
+[简体中文](./README.md)
+
+## Features
+
+* Provides standard account email templates
+* Supports email template localization
+* Integrates with ABP Virtual File System
+* Uses ABP Text Template System
+
+## Module Dependencies
+
+```csharp
+[DependsOn(
+    typeof(AbpEmailingModule),
+    typeof(AbpAccountApplicationContractsModule))]
+public class YouProjectModule : AbpModule
+{
+  // other
+}
+```
+
+## Email Templates
+
+### Template Definitions
+
+The module defines the following email templates:
+
+* `Abp.Account.MailConfirmLink` - Email Address Confirmation Template
+  * Used for user email address verification
+  * Template file: `/LINGYUN/Abp/Account/Emailing/Templates/MailConfirm.tpl`
+  * Uses standard email layout
+
+* `Abp.Account.MailSecurityVerifyLink` - Email Security Verification Template
+  * Used for email security verification
+  * Template file: `/LINGYUN/Abp/Account/Emailing/Templates/MailSecurityVerify.tpl`
+  * Uses standard email layout
+
+### Template System
+
+* Uses ABP Text Template System (TextTemplating)
+* Supports template localization
+* Template definition provider: `AccountTemplateDefinitionProvider`
+
+## Localization
+
+The module includes localization resources:
+* Resource type: `AccountResource`
+* Resource path: `/LINGYUN/Abp/Account/Templates/Localization/Resources`
+
+## Virtual File System
+
+The module uses ABP Virtual File System to manage template files:
+* All template files are embedded through the virtual file system
+* Supports template file override and customization
diff --git a/aspnet-core/modules/account/LINGYUN.Abp.Account.Templates/README.md b/aspnet-core/modules/account/LINGYUN.Abp.Account.Templates/README.md
new file mode 100644
index 000000000..e740a7dab
--- /dev/null
+++ b/aspnet-core/modules/account/LINGYUN.Abp.Account.Templates/README.md
@@ -0,0 +1,58 @@
+# LINGYUN.Abp.Account.Templates
+
+ABP账户模块的邮件模板定义模块，提供账户相关的邮件模板功能。
+
+[English](./README.EN.md)
+
+## 功能特性
+
+* 提供标准的账户邮件模板
+* 支持邮件模板本地化
+* 集成ABP虚拟文件系统
+* 使用ABP文本模板系统
+
+## 模块引用
+
+```csharp
+[DependsOn(
+    typeof(AbpEmailingModule),
+    typeof(AbpAccountApplicationContractsModule))]
+public class YouProjectModule : AbpModule
+{
+  // other
+}
+```
+
+## 邮件模板
+
+### 模板定义
+
+模块定义了以下邮件模板：
+
+* `Abp.Account.MailConfirmLink` - 邮件地址确认模板
+  * 用于用户邮箱地址验证
+  * 模板文件：`/LINGYUN/Abp/Account/Emailing/Templates/MailConfirm.tpl`
+  * 使用标准邮件布局
+
+* `Abp.Account.MailSecurityVerifyLink` - 邮件安全验证模板
+  * 用于邮箱安全验证
+  * 模板文件：`/LINGYUN/Abp/Account/Emailing/Templates/MailSecurityVerify.tpl`
+  * 使用标准邮件布局
+
+### 模板系统
+
+* 使用ABP文本模板系统（TextTemplating）
+* 支持模板本地化
+* 模板定义提供者：`AccountTemplateDefinitionProvider`
+
+## 本地化
+
+模块包含本地化资源：
+* 资源类型：`AccountResource`
+* 资源路径：`/LINGYUN/Abp/Account/Templates/Localization/Resources`
+
+## 虚拟文件系统
+
+模块使用ABP虚拟文件系统来管理模板文件：
+* 所有模板文件都通过虚拟文件系统嵌入
+* 支持模板文件的覆盖和自定义