Optimize document

Author: Enaium

document/en/guide/quickstart.md

@@ -2,47 +2,47 @@
 
 ## Install
 
-###  Prerequisites
+### Prerequisites
 
-- Intellij `2023.1` or later.
+- IntelliJ IDEA 2023.1 or later
 
-### Install in Intellij
+### Install via IntelliJ
 
 1. Open IntelliJ IDEA.
 2. Go to `File` > `Settings` > `Plugins`.
 3. Click `Marketplace`.
 4. Search for `JimmerBuddy` and install it.
 
-### Install online
+### Install Online
 
-1. Open [the link](https://plugins.jetbrains.com/plugin/26622-jimmer-buddy)
-2. Click `Get` button.
+1. Open [this link](https://plugins.jetbrains.com/plugin/26622-jimmer-buddy).
+2. Click the `Get` button.
 
-### Install offline
+### Install Offline
 
-1. Open [the link](https://plugins.jetbrains.com/plugin/26622-jimmer-buddy)
-2. Click `versions` button.
+1. Open [this link](https://plugins.jetbrains.com/plugin/26622-jimmer-buddy).
+2. Click the `Versions` button.
 3. Download the latest version.
-4. Install the plugin from `File` > `Settings` > `Plugins` > `Install plugin from disk...`.
+4. In IntelliJ, go to `File` > `Settings` > `Plugins` > `Install plugin from disk...` and select the downloaded file.
 
 ## FAQ
 
 ### Why is the plugin not available?
 
-- Please wait for the project to be indexed, then reopen the project
+- Please wait for the project to finish indexing, then reopen the project.
 
-### What time will the plugin generate draft, props, etc.?
+### When does the plugin generate draft, props, etc.?
 
-- When you change the Java or Kotlin source, then wait 2 seconds
+- When you change Java or Kotlin source files, wait about 2 seconds.
 
-### What time will the plugin generate the DTO view, input, etc.?
+### When does the plugin generate DTO view, input, etc.?
 
-- When you change the DTO source, then wait 2 seconds
+- When you change DTO source files, wait about 2 seconds.
 
-### Why does the plugin not generate source for Immutable and DTO
+### Why doesn't the plugin generate source for Immutable and DTO?
 
-- Please check the plugin log tool window on the bottom or the left bottom, then create an issue
+- Please check the plugin log tool window at the bottom or lower left, then create an issue if needed.
 
-### Why generated source is not same as the Jimmer's apt/ksp
+### Why is the generated source different from Jimmer's apt/ksp?
 
-Do not worry, the Jimmer's apt/ksp will generate full source when your project builds.
+- Don't worry, Jimmer's apt/ksp will generate the full source when your project builds.

document/en/guide/what-is-jimmerbuddy.md

@@ -1,39 +1,39 @@
 # What is JimmerBuddy?
 
-JimmerBuddy is a intellij plugin for project jimmer. Before, you needed to clean and build the project manually to generate the code. Now, you can generate any code when you change the source code.
+JimmerBuddy is an IntelliJ plugin for the Jimmer project. Previously, you needed to manually clean and build the project to generate code. Now, you can generate code automatically whenever you change the source code.
 
 ::: tip
-Just want to try it out? Skip to the [Quick Start](./quickstart.md)
+Just want to try it out? Skip to the [Quickstart](./quickstart.md)
 :::
 
-## First-class Java/Kotlin development
+## First-class Java/Kotlin Development
 
-- Automatically generate code from your source code. such as `draft`, `fetcher`, `props` etc.
+- Automatically generate code from your source code, such as `draft`, `fetcher`, `props`, etc.
 - List all `Immutables`, `DTOs`, and `ErrorFamilies` in the project.
-- Generate entity from database or ddl file.
+- Generate entities from a database or DDL file.
 - Jimmer project wizard.
-- Inspection for jimmer annotations.
-- Navigate to Immutable or Prop.
-- Complation for jimmer annotations.
-- Genreate all set of Draft.
-- DTO class member go to DTO file.
+- Inspections for Jimmer annotations.
+- Navigate to `Immutable` or `Prop`.
+- Completion for Jimmer annotations.
+- Generate all sets of `Draft`.
+- Navigate from DTO class members to DTO files.
 - Execute SQL to clipboard.
 - DTO type count and navigation.
 - Immutable inheritor count and navigation.
 
-## First-class DTO development
+## First-class DTO Development
 
-- Automatically generate `view`, `input`, `specification` etc. class for DTO.
-- Syntax highlight.
-- Syntax check.
-- Native compiler check.
+- Automatically generate `view`, `input`, `specification`, etc. classes for DTOs.
+- Syntax highlighting.
+- Syntax checking.
+- Native compiler checking.
 - Navigation to `type`, `prop`, `import`, `annotation`, etc.
-- Completion `export`, `package`, `import`, `prop`, `macro`, `config` etc.
-- Automatically import for `export`, `implements`, `userProp` etc.
-- Format source.
+- Completion for `export`, `package`, `import`, `prop`, `macro`, `config`, etc.
+- Automatic import for `export`, `implements`, `userProp`, etc.
+- Format source code.
 - Structure view.
-- Visualization to create DTO file.
+- Visualize and create DTO files.
 
-## Supported annotations
+## Supported Annotations
 
 `@Entity`, `@OneToOne`, `@OneToMany`, `@ManyToMany`, `@IdView`, `@Formula`

document/en/index.md

@@ -4,7 +4,7 @@ layout: home
 hero:
   name: "JimmerBuddy"
   text: "First-class support for Project Jimmer"
-  tagline: "A Intellij Plugin"
+  tagline: "An IntelliJ Plugin"
   image:
     src: /logo.svg
     alt: VitePress
@@ -21,13 +21,13 @@ hero:
 
 features:
   - icon: 🎯
-    title: Focus on You Code
-    details: Chcek your code about Jimmer annotations
+    title: Focus on Your Code
+    details: Check your code for Jimmer annotations
   - icon: ❤️
     title: Enjoy the Power of Jimmer
     details: Helpful code completion, code analysis, and more
   - icon: 🚀
-    title: Fast to generate code
-    details: Generate code without cleaning and compiling the project
+    title: Fast Code Generation
+    details: Generate code instantly without cleaning or compiling the project
 ---
 

document/en/reference/feature-inspection.md

@@ -1,51 +1,51 @@
 # Inspection
 
-JimmerBuddy provide some inspection features to help you find problems in your code.
+JimmerBuddy provides several inspection features to help you identify problems in your code.
 
-## Association
+## Association Annotations
 
-Check some annotations of the association.
+Checks for correct usage of association annotations:
 
-- `@OneToOne` and `@ManyToOne` can not at collection property.
-- `@OneToMany` and `@ManyToMany` can not at non-collection property.
+- `@OneToOne` and `@ManyToOne` cannot be used on collection properties.
+- `@OneToMany` and `@ManyToMany` cannot be used on non-collection properties.
 
-## MappedBy
+## MappedBy Property
 
-Check the `mappedBy` property of the association.
+Checks the `mappedBy` property of associations:
 
-- `mappedBy` prop must exist.
-- `mappedBy` prop type must match the inverse property type.
+- The `mappedBy` property must exist.
+- The `mappedBy` property type must match the inverse property type.
 
-## IdView
+## IdView Annotation
 
-Check the `@IdView` annotation.
+Checks the `@IdView` annotation:
 
-- `value` must exist if the property is a collection.
-- Property type must be a collection if the type is a generic type.
-- Base prop must exist.
+- The `value` must exist if the property is a collection.
+- The property type must be a collection if the type is generic.
+- The base property must exist.
 
-## Formula
+## Formula Annotation
 
-Check the `@Formula` annotation.
+Checks the `@Formula` annotation:
 
-- `dependencies` must exist.
+- The `dependencies` property must exist.
 
-## FetchBy
+## FetchBy Annotation
 
-Check the `@FetchBy` annotation.
+Checks the `@FetchBy` annotation:
 
-- Property must be a fetcher.
-- Property must exist.
-- Fetcher type must match the fetch type.
+- The property must be a fetcher.
+- The property must exist.
+- The fetcher type must match the fetch type.
 
-## Immutable
+## Immutable Annotations
 
-Check some annotations about Immutable such as  `@Immutable`, `@Entity`, `@MappedSuperclass`, and `@Embeddable`.
+Checks for correct usage of immutable-related annotations such as `@Immutable`, `@Entity`, `@MappedSuperclass`, and `@Embeddable`:
 
-- Must on the interface.
+- Must be used on interfaces.
 
-## OrderedProp
+## OrderedProp Annotation
 
-Check the `@OrderedProp` annotation.
+Checks the `@OrderedProp` annotation:
 
-- `value` must exist.
+- The `value` property must exist.