Skip to content

Commit e98b040

Browse files
committed
docs: adjust documentations and fill out some TBD that can be filled
1 parent b0fbf9a commit e98b040

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

apps/documentation/docs/api/canvas.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The root of a NGT 3D scene is the `NgtCanvas` component
1515
| name | description | type | default |
1616
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------ |
1717
| **sceneGraph** | **(required)** A component that will be rendered as the Root THREE.Scene | `Type<any>` | |
18-
| compoundPrefixes | An array of prefixes of HTML tags that NGT will treat as [TBD: Compound](#) | `string[]` | `[]` |
18+
| compoundPrefixes | An array of prefixes of HTML tags that NGT will treat as [Compound](../advanced/compound) | `string[]` | `[]` |
1919
| gl | A THREE.js Renderer instance of options that go into the default Renderer. It also accepts a callback that returns a THREE.js Renderer instance | `NgtGLOptions` | - |
2020
| size | Dimensions to fit the THREE.js Renderer to. Will measure `<canvas>` dimentions if omitted | `NgtSize` | - |
2121
| shadows | Enables PCFsoft shadows. Can accept `gl.shadowMap` options for fine-tuning | `boolean`, `Partial<THREE.WebGLShadowMap>` | `false` |

apps/documentation/docs/api/custom-renderer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ See [Render Priority](#render-priority)
235235

236236
### `rawValue`
237237

238-
See [TBD: ngt-value](#)
238+
See [Raw Value](./raw-value)
239239

240240
### `ref`
241241

apps/documentation/docs/getting-started/first-scene.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ export class AppComponent {
7575
`ngt-canvas` sets up the following:
7676

7777
- A `WebGLRenderer`, a default `Scene`, and a default `PerspectiveCamera`
78-
- A render loop that renders our scene evere frame outside of Angular Zone
78+
- A render loop that renders our scene evere frame outside of Change Detection
7979
- A `window:resize` listener that updates our Renderer and Camera when the viewport is resized
8080

8181
`ngt-canvas` renders the `SceneGraph` input in a _detached_ environment from Angular Change Detection. It also provides the custom Angular Renderer
@@ -438,7 +438,7 @@ Familiar, right? This is one of the goals of NGT. Interact with the cube now and
438438

439439
- `(click)`, `(pointerover)`, and `(pointerout)` look like DOM events but they are not. These events are named as such
440440
to give a sense of familiarity to Angular developers.
441-
- These events get back into Angular Zone so we can update states (eg: `hovered` and `active`). Normally, NGT runs outside of Angular Zone.
441+
- These events automatically calls `changeDetectorRef.detectChanges` so we can update states (eg: `hovered` and `active`).
442442

443443
Now that our cube is _interactive_ and _fun_, we can render another `demo-cube` to _double the fun_. But first, we need to add a `position` input
444444
so we can show both `Cube` in different positions on the Scene.

libs/angular-three/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export class Scene {}
5151

5252
## Documentations
5353

54-
Read more about Angular Three usages in [TBD Documentations]()
54+
Read more about Angular Three usages in [Documentations](https://angular-threejs.netlify.app)
5555

5656
## Contributions
5757

0 commit comments

Comments
 (0)