Переглянути джерело

fix: improved grammer & fixed some typos in docs

Okoro Redemption 2 роки тому
батько
коміт
63b7aa44ef

+ 1 - 1
CONTRIBUTING.md

@@ -4,7 +4,7 @@
 
 Hi there!! If you are reading this guide, you are probably interested in contributing to Tres. You're awesome 🤩.
 
-No contribution is too small, whenever is about a typo in the docs, a bug report or refactoring a piece of code, every contribution is welcome, just make sure to follow the guidelines below ✌️.
+No contribution is too small, whether it is a typo in the docs, a bug report or refactoring a piece of code, every contribution is welcome, just make sure to follow the guidelines below ✌️.
 
 Thanks from the heart 💚 for taking the time to help out. This guide will help you to get started with the project.
 

+ 5 - 5
docs/api/composables.md

@@ -2,13 +2,13 @@
 
 Vue 3 [Composition API](https://vuejs.org/guide/extras/composition-api-faq.html#what-is-composition-api) allows you to create reusable logic that can be shared across components. It also allows you to create custom hooks that can be used in your components.
 
-TresJS takes huge advantage of this API to create a set of composable functions that can be used to create animations, interact with the scene, and more. It also allows you to create more complex scenes that might not be possible using just the Vue Components (Textures, Loaders, etc.).
+**TresJS** takes huge advantage of this API to create a set of composable functions that can be used to create animations, interact with the scene and more. It also allows you to create more complex scenes that might not be possible using just the Vue Components (Textures, Loaders, etc.).
 
-The core of TresJS uses these composables internally, so you would be using the same API that the core uses. For instance, components that need to updated on the internal render loop use the `useRenderLoop` composable to register a callback that will be called every time the renderer updates the scene.
+The core of **TresJS** uses these composables internally, so you would be using the same API that the core uses. For instance, components that need to updated on the internal render loop use the `useRenderLoop` composable to register a callback that will be called every time the renderer updates the scene.
 
 ## useRenderLoop
 
-The `useRenderLoop` composable is the core of TresJS animations. It allows you to register a callback that will be called on native refresh rate. This is the most important composable in TresJS.
+The `useRenderLoop` composable is the core of **TresJS** animations. It allows you to register a callback that will be called on native refresh rate. This is the most important composable in **TresJS**.
 
 ```ts
 const { onLoop, resume } = useRenderLoop()
@@ -27,7 +27,7 @@ The `onLoop` callback receives an object with the following properties based on
 - `delta`: The delta time between the current and the last frame. This is the time in seconds since the last frame.
 - `elapsed`: The elapsed time since the start of the render loop.
 
-This composable is based on `useRafFn` from [vueuse](https://vueuse.org/core/useRafFn/). Thanks to [@wheatjs](https://github.com/orgs/Tresjs/people/wheatjs) for the amazing contribution.
+This composable is based on `useRafFn` from [vueuse](https://vueuse.org/core/useRafFn/). Thanks to [@wheatjs](https://github.com/orgs/**Tresjs**/people/wheatjs) for the amazing contribution.
 
 ### Before and after render
 
@@ -150,7 +150,7 @@ The `useCatalogue` composable allows you to extend the internal catalogue of com
 This is specially useful if you want to use objects that are not part of ThreeJS core like[OrbitControls](https://threejs.org/docs/#examples/en/controls/OrbitControls) or third party functionality, like physics.
 
 ```ts
-import { useCatalogue } from '@tresjs/core'
+import { useCatalogue } from '@**tresjs**/core'
 import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls'
 
 const { extend } = useCatalogue()

+ 1 - 1
docs/api/instances-arguments-and-props.md

@@ -21,7 +21,7 @@ With **Tres** you don't need to import anything, that's because **Tres** automat
 </template>
 ```
 
-This mean that you can the same [documentation](https://threejs.org/docs/) as you where using plain ThreeJS, but with the power of Vue.
+This means that you can use the same [documentation](https://threejs.org/docs/) as you would when using plain ThreeJS, but with the power of Vue.
 
 ## Declaring objects
 

+ 2 - 2
docs/guide/your-first-scene.md

@@ -4,7 +4,7 @@ This guide will help you to create your first Tres scene. 🍩
 
 ## Setting up the experience Canvas
 
-Before we can create an Scene, we need somewhere to display it. Using plain [ThreeJS](https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene) we would need yo create a `canvas` html element to mount the `WebglRenderer` and initialize the `scene`
+Before we can create an Scene, we need somewhere to display it. Using plain [ThreeJS](https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene) we would need to create a `canvas` html element to mount the `WebglRenderer` and initialize the `scene`
 
 With **TresJS** you only need to add the default component `<TresCanvas />` to the template of your Vue component.
 
@@ -91,4 +91,4 @@ Notice that we don't need to import anything, thats because **TresJS** automatic
 
 <FirstScene />
 
-From that on you can start adding more objects to your scene, and start playing with the properties of the components to see how they affect the scene.
+From here onwards you can start adding more objects to your scene and start playing with the properties of the components to see how they affect the scene.