Parcourir la source

Apply suggestions from code review

Co-authored-by: Konstantin BIFERT <hello@kissu.io>
Alvaro Saburido il y a 2 ans
Parent
commit
7c8779090e
2 fichiers modifiés avec 13 ajouts et 11 suppressions
  1. 3 3
      docs/examples/basic-animations.md
  2. 10 8
      docs/examples/orbit-controls.md

+ 3 - 3
docs/examples/basic-animations.md

@@ -17,13 +17,13 @@ const { onLoop, resume } = useRenderLoop()
 
 resume()
 onLoop(({ _delta, elapsed }) => {
-  // I will run at every frame ~ 60FPS (depending on the browser)
+  // I will run at every frame ~ 60FPS (depending of your monitor)
 })
 ```
 
 ## Getting the reference to the cube
 
-To animate the cube, we need to get a reference to it. We can do it by passsing a [Template Ref](https://vuejs.org/guide/essentials/template-refs.html) using `ref` prop to the `TresMesh` component. This will return the THREE instance.
+To animate the cube, we need to get a reference to it. We can do it by passing a [Template Ref](https://vuejs.org/guide/essentials/template-refs.html) using `ref` prop to the `TresMesh` component. This will return the THREE instance.
 
 ```vue
 <script setup lang="ts">
@@ -40,7 +40,7 @@ const boxRef: Ref<TresInstance | null> = ref(null)
 
 ## Animating the cube
 
-Now that we have a reference to the cube, we can animate it. We will use the `onLoop` callback to update the cube rotation.
+Now that we have a reference to the cube, we can animate it. We will use the `onLoop` callback to update the cube's rotation.
 
 ```ts
 onLoop(({ _delta, elapsed }) => {

+ 10 - 8
docs/examples/orbit-controls.md

@@ -4,17 +4,17 @@
 
 [OrbitControls](https://threejs.org/docs/index.html?q=orbit#examples/en/controls/OrbitControls) is a camera controller that allows you to orbit around a target. It's a great way to explore your scene.
 
-However is not part of the core of ThreeJS. So to use it you would need to import it from the `three/examples/jsm/controls/OrbitControls` module.
+However, it is not part of the core of ThreeJS. So to use it you would need to import it from the `three/examples/jsm/controls/OrbitControls` module.
 
-So this creates a problem because **TresJS** automatically creates a catalogue of the core of three so you can use them as components.
+This creates a problem because **TresJS** automatically creates a catalog of the core of Three so you can use them as components.
 
-Afortunatelly, **TresJS** provides a way to extend the catalogue of components. You can do it by using the `extend` method the [useCatalogue](/composables/use-catalog) composable.
+Fortunately, **TresJS** provides a way to extend the catalog of components. You can do it by using the `extend` method using the [useCatalogue](/composables/use-catalog) composable.
 
-For more information about extending you TresJS catalog, refer to [extending](/advanced/extending.md) section.
+For more information about extending your TresJS catalog, refer to the [extending](/advanced/extending.md) section.
 
 ## Using OrbitControls
 
-To use OrbitControls you need to import it from the `three/examples/jsm/controls/OrbitControls` module.
+To use `OrbitControls` you need to import it from the `three/examples/jsm/controls/OrbitControls` module.
 
 ```js
 import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls'
@@ -31,7 +31,7 @@ const { extend } = useCatalogue()
 extend({ OrbitControls })
 ```
 
-Now you can use the `OrbitControls` component in your scene.
+Now you can use the `TresOrbitControls` component in your scene.
 
 ```vue
 <template>
@@ -78,9 +78,11 @@ const { state } = useThree()
 
 ## OrbitControls from `cientos`
 
-Here is where the fancy part begins. The `cientos` package provides a component called `<OrbitControls />` that is a wrapper of the `OrbitControls` from the `three-stdlib` module.
+Here is where the fancy part begins. ✨  
+The `cientos` package provides a component called `<OrbitControls />` that is a wrapper of the `OrbitControls` from the [`three-stdlib`](https://github.com/pmndrs/three-stdlib) module.
 
-The nicest part? You don't need to extend the catalogue or pass any arguments. It just works.
+The nicest part? You don't need to extend the catalog or pass any arguments.  
+It just works. 💯 
 
 ```vue
 <template>