Skip to content

Commit

Permalink
Update descriptions
Browse files Browse the repository at this point in the history
adeira-source-id: f4bce1e09d72fc0c12f3b0d48e908d8eb36ff591
  • Loading branch information
itsdouges authored and triplex-bot committed Dec 12, 2023
1 parent 85a626d commit 69e7c52
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 11 deletions.
1 change: 1 addition & 0 deletions apps/docs/pages/docs/get-started/user-interface.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: User Interface
description: Learn about the Triplex UI and how to get around it.
---

The Triplex UI is split into three quadrants.
Expand Down
7 changes: 7 additions & 0 deletions apps/docs/pages/docs/setup/javascript-projects.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
description:
Triplex works best with TypeScript as the rich type information is used to
populate the editor controls, however if you're not yet using TypeScript
you're still able to use Triplex.
---

Triplex works best with TypeScript as the rich type information is used to
populate the editor controls, however if you're not yet using TypeScript you're
still able to use Triplex.
Expand Down
3 changes: 3 additions & 0 deletions apps/docs/pages/docs/setup/manual-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Manual Setup
description:
If you'd prefer to set up your project manually instead of using the Create
project action in Triplex you can do so following this guide.
---

If you'd prefer to set up your project manually instead of using the "Create
Expand Down
3 changes: 3 additions & 0 deletions apps/docs/pages/docs/setup/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: Setting up Triplex
description:
It's quick and easy to get up and running with Triplex. With a small download
it'll only take you a few minutes.
---

It's quick and easy to get up and running with Triplex. With a small download
Expand Down
15 changes: 9 additions & 6 deletions apps/docs/pages/docs/user-guide/built-in-glsl-support.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
---
title: Built-in GLSL Support
description:
GLSL shaders are small programs that are ran on the GPU. When imported they
have their include statements resolved and are then available as a string for
you to forward on to Three.js.
---

Triplex comes with out-of-the-box support for GLSL shader files.

When importing a GLSL file with an extension of `glsl`, `wgsl`, `vert`, `frag`,
`vs`, or `fs`, they will have all `#include` statements resolved and be returned
as a string for you to use in Three.js materials.
GLSL shaders are small programs that are ran on the GPU. When importing a GLSL
file with an extension of `glsl`, `wgsl`, `vert`, `frag`, `vs`, or `fs`, they
have their include statements resolved and are then available as a string for
you to forward on to Three.js.

Import them:

```tsx
import vert from "./vertex.glsl";
import frag from "./fragment.glsl";
import vert from "./vertex.glsl";
```

And use them as needed, for example here it's used with
Expand Down
10 changes: 9 additions & 1 deletion apps/docs/pages/docs/user-guide/live-edit-props.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
Edit props of the component you have open without writing any boiler plate code.
---
description:
Edit props of the currently opened component without writing any boiler plate
code that persist for the duration of your session.
---

Edit props of the currently opened component without writing any boiler plate
code that persist for the duration of your session.

For the component you want to edit click the "live edit props" action in the
scene panel and you're presented with all the props it takes available to be
edited.
Expand Down
6 changes: 6 additions & 0 deletions apps/docs/pages/docs/user-guide/prop-tags.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
description:
Tags declared on component props such as @max and @min are respected by
Triplex.
---

Component props can declare optional JSDoc tags that give Triplex extra
information about how to handle the prop through the UI. A prop can have
multiple tags declared.
Expand Down
17 changes: 13 additions & 4 deletions apps/docs/pages/docs/user-guide/provider-config.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
When [defining a provider in config](/docs/api-reference/config#provider) any
props that it takes can be modified in the UI, allowing you to tailor your
project configuration to your needs.
---
description:
A provider component is used to set up the global environment of your app,
such as physics or post-processing. Any declared props can be changed during a
session.
---

Access it through the "view provider controls" action in the scene panel.
A provider component is used to set up the global environment of your app, such
as physics or post-processing.

When [defining it in config](/docs/api-reference/config#provider) any prop that
it takes can be modified in the UI, allowing you to tailor your project
configuration to your needs. Access it through the "view provider controls"
action in the scene panel.

![Triplex UI](/ui/provider-config.png)

Expand Down

0 comments on commit 69e7c52

Please sign in to comment.