完善部分文档 (cocos#1570)

* 完善部分文档

* Commit changes

Author: xunyi0

en/asset/asset-manager-upgrade-guide.md

@@ -1,7 +1,7 @@
 # Asset Manager Upgrade Guide
 
 > Author: Santy-Wang, Xunyi
-
+>
 > This article details what to expect when upgrading from loader to assetManager.
 
 Before Creator v2.4, [Acquire and load asset](https://github.com/cocos-creator/creator-docs/blob/e02ac31bab12d3ee767c0549050b0e42bd22bc5b/en/scripting/load-assets.md) was implemented through the `loader` module (including the APIs `loader.load`, `loader.loadRes`, `loader.loadResDir`, etc.), which was primarily used to load resources. However, with the continuous development of Creator, developers' demands for resource management have been increasing. The original `loader` module has been unable to meet a large number of resource management needs, and a new resource management module is in the air.

en/asset/dcc-export-mesh.md

@@ -28,7 +28,7 @@ You can see that the rotation data is gone in __Cocos Creator 3.0__.
 
 ## Exporting glTF
 
-Please read ther following documents:
+Please read their following documents:
 - [glTF also uses a right-handed coordinate system](https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#coordinate-system-and-units)
 - [Options for exporting glTF in Blender](https://docs.blender.org/manual/en/2.80/addons/io_scene_gltf2.html). It is relatively simple, as long as the __+y up__ option is checked, there is no rotation value in the exported data.
 

en/asset/dynamic-load-resources.md

@@ -34,7 +34,7 @@ resources.load("test assets/anim", AnimationClip, (err, clip) => {
 After the image is set to a spriteframe, texture or other image types, an asset of the corresponding type will be generated in the **Assets Panel**. But if `test assets/image` is loaded directly, and the type will be `ImageAsset`. You must specify the full path of sub asset, then the generated SpriteFrame can be loaded.
 
 ```typescript
-// load a SpriteFrame，image is ImageAsset，spriteFrame is image/spriteFrame, texture is image/texture
+// load a SpriteFrame, image is ImageAsset, spriteFrame is image/spriteFrame, texture is image/texture
 resources.load("test assets/image/spriteFrame", SpriteFrame, (err, spriteFrame) => {
     this.node.getComponent(Sprite).spriteFrame = spriteFrame;
 });

en/asset/render-texture.md

@@ -29,15 +29,15 @@ export class CaptureToWeb extends Component {
             borderRight: spriteframe.insetRight,
         });
 
-        const rendetTex = this._renderTex = new RenderTexture();
-        rendetTex.reset({
+        const renderTex = this._renderTex = new RenderTexture();
+        renderTex.reset({
             width: 256,
             height: 256,
             colorFormat: RenderTexture.PixelFormat.RGBA8888,
             depthStencilFormat: RenderTexture.DepthStencilFormat.DEPTH_24_STENCIL_8
         });
-        this.camera.targetTexture = rendetTex;
-        sp.texture = rendetTex;
+        this.camera.targetTexture = renderTex;
+        sp.texture = renderTex;
         this.sprite.spriteFrame = sp;
     }
 }
@@ -65,4 +65,4 @@ export class RenderCameraToModel extends Component {
 }
 ```
 
-For more __Render Texture__ examples, please see these [test casees](https://github.com/cocos-creator/test-cases-3d/tree/master/assets/cases/rendertexture).
+For more __Render Texture__ examples, please see these [test cases](https://github.com/cocos-creator/test-cases-3d/tree/v3.0/assets/cases/rendertexture).

en/concepts/scene/fog.md

@@ -33,7 +33,7 @@ To increase the density of Linear Fog when the distance between the camera and t
 1. fix the value of `FogStart` and decrease the value of `FogEnd`.
 2. Decrease the value of `FogStart` and fix the value of `FogEnd`.
 
-To adjust the fog effect to the right consistency, it is best to adjust both the `FogStart` and `FogEnd` properties appropriately. An example effect of Linear Fog is shown below：
+To adjust the fog effect to the right consistency, it is best to adjust both the `FogStart` and `FogEnd` properties appropriately. An example effect of Linear Fog is shown below:
 
 ![image](./fog/linear_fog.png)
 

en/editor/components/dragonbones.md

@@ -83,9 +83,10 @@ The following is an example of how DragonBones replaces the texture. Replace the
             this._rightDisplayIndex %= this._rightDisplayNames.length;
             let armature = this.armatureDisplay!.armature();
             let slot = armature!.getSlot("weapon_hand_r");
+            let replaceArmatureName = this.replaceArmatureDisplay!.armatureName;
             const displayName = this._rightDisplayNames[this._rightDisplayIndex];
             let factory = dragonBones.CCFactory.getInstance() as any;
-            factory.replaceSlotDisplay(this.replaceArmatureDisplay!.getArmatureKey(), "weapon", "weapon_r", displayName, slot);
+            factory.replaceSlotDisplay(this.replaceArmatureDisplay!.getArmatureKey(), replaceArmatureName , "weapon_r", displayName, slot);
 
             let offset = this._rightDisplayOffset[this._rightDisplayIndex];
             slot!.parent.offset.x = offset.x;
@@ -111,7 +112,9 @@ The following is an example of how DragonBones replaces the texture. Replace the
 
     ![dragonbones-cloth](./dragonbones/cloth4.png)
 
-    > **Note**: if the scene is not displayed when previewing, check that the `Layer` property of each node is consistent with that of the `Camera` node.
+    > **Notes**:
+    > 1. After the example is run, the weapon style replaced by the right hand is not consistent with the weapon style prepared in the Scene, which is caused by the resource problem, please refer to the specific code implementation.
+    > 2. If the scene is not displayed when previewing, check that the `Layer` property of each node is consistent with that of the `Camera` node.
     >
     > ![layer](./dragonbones/layer.png)
 

en/editor/extension/contributions.md

@@ -25,6 +25,6 @@ interface contributions {
 }
 ```
 
-The name is the name of the function or extension, and the value is of any type, which is defined by the author of the name function (extension).
+The `name` is the name of the function or extension, and the `value` is of type `any`, which is defined by the author of the `name` function (extension).
 
-At this stage, only contributions to the internal functions of the editor are opened. In the future, we will provide the ability to use contributions between extensions.
+At this stage, only `contributions` to the internal functions of the editor is opened, in the future we will provide a more convenient way of using `contributions` between extensions.

en/editor/project/physics-configs.md

@@ -6,16 +6,16 @@ Physical configuration is used to configure various commonly used properties.
 
 ![Physics](./index/physics-index.png)
 
-- `gravity` Gravity direction vector, the sign means the positive or negative direction on the axis. **Default:** `{ x: 0, y: -10, z: 0 }`.
-- `allowSleep` Whether to allow rigid bodies to enter sleep state. **Default:** `true`.
-- `sleepThreshold` The maximum speed threshold for entering sleep. **Default:** `0.1`，**Min:** `0`.
+- `gravity` Gravity direction vector, the sign means the positive or negative direction on the axis. **Default**: `{ x: 0, y: -10, z: 0 }`.
+- `allowSleep` Whether to allow rigid bodies to enter sleep state. **Default**: `true`.
+- `sleepThreshold` The maximum speed threshold for entering sleep. **Default**: `0.1`. **Min**: `0`.
 - `autoSimulation` Whether to enable automatic simulation.
-- `fixedTimeStep` Fixed time step between each simulation. **Default:** `1/60`, **Min:** `0`.
-- `maxSubSteps` Maximum number of substeps per simulation step. **Default:** `1`, **Min:** `0`.
-- `friction` Coefficient of friction. **Default:** `0.5`.
-- `rollingFriction` Rolling friction coefficient. **Default:** `0.1`.
-- `spinningFriction` Spin friction coefficient. **Default:** `0.1`.
-- `restitution` Coefficient of elasticity. **Default:** `0.1`.
+- `fixedTimeStep` Fixed time step between each simulation. **Default**: `1/60`. **Min**: `0`.
+- `maxSubSteps` Maximum number of substeps per simulation step. **Default**: `1`. **Min**: `0`.
+- `friction` Coefficient of friction. **Default**: `0.5`.
+- `rollingFriction` Rolling friction coefficient. **Default**: `0.1`.
+- `spinningFriction` Spin friction coefficient. **Default**: `0.1`.
+- `restitution` Coefficient of elasticity. **Default**: `0.1`.
 - `collisionMatrix` The collision matrix, used only for initialization.
 <!-- - `useNodeChains` Whether to use a node chain to combine rigid bodies. **Default:** `true`. -->
 

en/editor/publish/publish-bytedance-mini-game.md

@@ -8,9 +8,9 @@ The game submission, review and release process of a mini-game needs to comply w
 
 ## Publish to ByteDance with Cocos Creator
 
-1. Download the **ByteDance DevTools** on [ByteDance Official Website [cn]](https://microapp.bytedance.com/docs/zh-CN/mini-game/develop/developer-instrument/developer-instrument-update-and-download).
+1. Download the [ByteDance DevTools [cn]](https://microapp.bytedance.com/docs/zh-CN/mini-game/develop/developer-instrument/developer-instrument-update-and-download).
 
-2. Log in to [Developer Platform [cn]](https://microapp.bytedance.com/)to find your `mini game appid`. For details, please refer to the official [Access Guide [cn]](https://microapp.bytedance.com/docs/zh-CN/mini-game/introduction/plugin-reference/set-up-mini-game) documentation.
+2. Log in to [Developer Platform [cn]](https://microapp.bytedance.com/)to find your `mini game appid`. For details, please refer to the official [Access Guide [cn]](https://microapp.bytedance.com/docs/zh-CN/mini-game/introduction/plugin-reference/sign) documentation.
 
     ![appid](./publish-bytedance-mini-game/appid.png)
 

en/editor/publish/publish-huawei-agc.md

@@ -18,9 +18,9 @@ Use Cocos Creator to open the project that needs to be released. Open the **Buil
 
 For the settings of the general options, please refer to the [Build Options](build-options.md) document.
 
-- **agconnect-services Config**：Used to configure Huawei parameter file `agconnect-services.json`. Please refer to the [Configs HUAWEI Parameter File](https://service.cocos.com/document/en/sdkhub-plugins/sdkhub-hms.html#configs-huawei-config-file) for the specific configuration method.
+- **agconnect-services Config**: Used to configure Huawei parameter file `agconnect-services.json`. Please refer to the [Configs HUAWEI Parameter File](https://service.cocos.com/document/en/sdkhub-plugins/sdkhub-hms.html#configs-huawei-config-file) for the specific configuration method.
 
-- **Cocos SDKHub Config Set**: This option is used to help the game quickly intergrate the channel SDK. Please select the SDKHub service that you have previously enabled in the Cocos Services panel.
+- **Cocos SDKHub Config Set**: This option is used to help the game quickly integrate the channel SDK. Please select the SDKHub service that you have previously enabled in the Cocos Services panel.
 
 ![sdkhub](./publish-huawei-agc/sdkhub.png)
 

en/editor/publish/setup-native-development.md

@@ -34,11 +34,11 @@ On Windows platform, please confirm if `JAVA_HOME` is included in your environme
 
 After installing **Android Studio**, refer to the official documentation and open the **SDK Manager**: [SDK Manager Instructions](https://developer.android.com/studio/intro/update.html#sdk-manager).
 
-1. In the **SDK Platforms** tab page, check the API level you want to install, and it is recommended to select the required mainstream API Level such as `API Level 23 (6.0)`, `API Level 26 (8.0)` and `API Level 28 (9.0)`, etc.
+1. In the **SDK Platforms** tab page, check the API level you want to install, and it is recommended to select the required mainstream API Level such as `API Level 26 (8.0)`, `API Level 28 (9.0)`, etc.
 2. In the **SDK Tools** tab page, first check the lower right corner of the **Show Package Details**, show the version of the tool selection.
 3. In the **Android SDK Build-Tools**, select the latest build Tools version.
 4. Check the **Android SDK Platform-Tools** and **CMake**. If you need to install the **Android Support Library**, please refer to the official [Support Library Setup](https://developer.android.com/topic/libraries/support-library/setup).
-5. Check the **NDK** and the recommended version is **r20**.
+5. Check the **NDK** and the recommended version is **r20~21**. Note that the **NDK-r22** is not supported currently.
 6. Take note of the path of **Android SDK Location** on top of the **SDK Manager** window. Later we need to fill in the location of the SDK in **Cocos Creator**.
 7. Click **OK** and follow the prompts to complete the installation.
 
@@ -48,14 +48,14 @@ After installing **Android Studio**, refer to the official documentation and ope
 
 Please install the following running environment:
 
-- Python **2.7.5+**, [download page](https://www.python.org/downloads/). **Pay attention! Don't download Python 3.x version**.
-
 - In Windows, the installation of [Visual Studio 2017/2019 Community Edition](https://www.visualstudio.com/downloads/download-visual-studio-vs) is needed. When installing Visual Studio, please check **Desktop development with C++** and **Game development with C++** two modules.
 
   > **Note**: there is a **Cocos** option in the **Game development with C++** module. Do **NOT** check it.
 
 - In Mac, the installation of [Xcode](https://developer.apple.com/xcode/download/) and command line tool is needed.
 
+  > **Note**: Starting with v3.0.1, Xcode v11.5 and above is required.
+
 ## Configure Native Develop environments path
 
 Next, go back to Cocos Creator to configure the environmental path of the native platform. Choose **Cocos Creator -> Preferences** in the main menu, and open the **Preferences** panel. We need to configure the following two paths here:

en/engine/animation/animation-clip.md

@@ -11,7 +11,7 @@ When the animation system is operating, the __Animation Component__ calculates t
 The following code snippet demonstrates how to create __Animation Clips__ programmatically:
 
 ```ts
-import { AnimationClip, animation, js } from "cc";
+import { AnimationClip, animation, js } from 'cc';
 const animationClip = new AnimationClip();
 animationClip.duration = 1.0; // The cycle of the entire animation clip, no frame time should be greater than this attribute.
 animationClip.keys = [ [ 0.3, 0.6, 0.9 ] ]; // Frame time shared by all curves of this animation clip
@@ -221,7 +221,7 @@ When the `interpolate` property of the curve data is `true`, the curve will try
 If the curve value does not satisfy any of the above conditions, or when the `interpolate` property of the curve data is `false`, there will be no interpolation operation. Always use the curve value of the previous frame as the result.
 
 ```ts
-import { AnimationClip, color, IPropertyCurveData, SpriteFrame, Vec3 } from "cc";
+import { AnimationClip, color, IPropertyCurveData, SpriteFrame, Vec3 } from 'cc';
 
 const animationClip = new AnimationClip();
 
@@ -266,7 +266,7 @@ const spriteCurve: IPropertyCurveData = {
 The following code shows how to customize the **interpolation** algorithm:
 
 ```ts
-import { ILerpable, IPropertyCurveData, Quat, quat, Vec3, vmath } from "cc";
+import { ILerpable, IPropertyCurveData, Quat, quat, Vec3, vmath } from 'cc';
 
 class MyCurveValue implements ILerpable {
     public position: Vec3;

en/engine/animation/animation-component.md

@@ -5,7 +5,7 @@ __Animation components__ control the playback of animations.
 __Animation components__ are added to nodes in exactly the same way as other components:
 
 ```ts
-import { Animation, Node } from "cc";
+import { Animation, Node } from 'cc';
 
 function (node: Node) {
     const animationComponent = node.addComponent(Animation);
@@ -85,7 +85,7 @@ The `events` of an `AnimationClip` contains all event descriptions for the anima
 `func` represents the method name that is called back when the event is triggered. When the event is triggered, a **search** for a method named `func` on all components of the current node, once found, it is called with `params` passed to it. Example:
 
 ```ts
-import { Animation, Component } from "cc";
+import { Animation, Component } from 'cc';
 class MyScript extends Component {
     constructor() {
 

en/engine/event/event-emit.md

@@ -9,7 +9,7 @@ Event processing is done in the `Node`. Components can register and monitor even
 xxx.on(type, func, target?);
 ```
 
-The `type` is the event registration string. `func` is the callback to listen to when the event is executed. And `target` is the event receive object. If `target` is not set，then `this` in the callback refers to the object that is currently executing the callback.
+The `type` is the event registration string. `func` is the callback to listen to when the event is executed. And `target` is the event receive object. If `target` is not set, then `this` in the callback refers to the object that is currently executing the callback.
 
 The event listener function `on` can pass to the third parameter target to bind the caller of the response function. The following two calling methods have the same effect:
 
@@ -45,7 +45,7 @@ One thing to note is that the parameter of `off` must be in one-to-one correspon
 Example:
 
 ```ts
-import { _decorator, Component, Node } from "cc";
+import { _decorator, Component, Node } from 'cc';
 const { ccclass } = _decorator;
 
 @ccclass("Example")
@@ -78,7 +78,7 @@ xxx.emit(type, ...args);
 When emitting events, start passing the event parameters as the second argument of the emit function.
 
 ```ts
-import { _decorator, Component, Node } from "cc";
+import { _decorator, Component, Node } from 'cc';
 const { ccclass } = _decorator;
 
 @ccclass("Example")

en/engine/event/event-input.md

@@ -37,7 +37,7 @@ Event types included:
     - Event: [API Reference](__APIDOC__/en/classes/event.event-1.html)
 
 ```ts
-import { _decorator, Component, Node, systemEvent, SystemEventType, EventKeyboard, macro } from "cc";
+import { _decorator, Component, Node, systemEvent, SystemEventType, EventKeyboard, macro } from 'cc';
 const { ccclass } = _decorator;
 
 @ccclass("Example")
@@ -79,7 +79,7 @@ export class Example extends Component {
   - Event: [API Reference](__APIDOC__/en/classes/event.event-1.html)
 
 ```ts
-import { _decorator, Component, Node, systemEvent, SystemEventType, log } from "cc";
+import { _decorator, Component, Node, systemEvent, SystemEventType, log } from 'cc';
 const { ccclass } = _decorator;
 
 @ccclass("Example")

en/getting-started/first-game/index.md

@@ -99,7 +99,7 @@ It is necessary for the main character to be affected when the mouse moves. To d
 There are already some pre-set code blocks in the `PlayerController` script. Example:
 
 ```ts
-import { _decorator, Component } from "cc";
+import { _decorator, Component } from 'cc';
 const { ccclass, property } = _decorator;
 
 @ccclass("PlayerController")
@@ -126,7 +126,7 @@ This code is the structure needed to write a __component__. Scripts with this st
 Monitoring of mouse events needs to be added in the script to let the `Player` node move. Modify the code in `PlayerController` as follows:
 
 ```ts
-import { _decorator, Component, Vec3, systemEvent, SystemEvent, EventMouse, Animation } from "cc";
+import { _decorator, Component, Vec3, systemEvent, SystemEvent, EventMouse, Animation } from 'cc';
 const { ccclass, property } = _decorator;
 
 @ccclass("PlayerController")
@@ -295,7 +295,7 @@ It is necessary to make the basic element `cube` of the road into a __Prefab__,
 A very long road is needed. The ideal method is to dynamically increase the length of the road, so that the `Player` can run forever. First, generate a fixed-length road with a length that is arbitrary. To do so, replace the code in the `GameManager` script with the following code:
 
 ```ts
-import { _decorator, Component, Prefab, instantiate, Node, CCInteger} from "cc";
+import { _decorator, Component, Prefab, instantiate, Node, CCInteger} from 'cc';
 const { ccclass, property } = _decorator;
 
 enum BlockType{
@@ -776,7 +776,7 @@ When previewing, the results are as follows:
 The final code for `PlayerController.ts` should look like this:
 
 ```ts
-import { _decorator, Component, Vec3, systemEvent, SystemEvent, EventMouse, Animation, SkeletalAnimation } from "cc";
+import { _decorator, Component, Vec3, systemEvent, SystemEvent, EventMouse, Animation, SkeletalAnimation } from 'cc';
 const { ccclass, property } = _decorator;
 
 @ccclass("PlayerController")
@@ -883,7 +883,7 @@ export class PlayerController extends Component {
 The final code for `GameManager.ts` should look like this:
 
 ```ts
-import { _decorator, Component, Prefab, instantiate, Node, Label, CCInteger, Vec3 } from "cc";
+import { _decorator, Component, Prefab, instantiate, Node, Label, CCInteger, Vec3 } from 'cc';
 import { PlayerController } from "./PlayerController";
 const { ccclass, property } = _decorator;