Skip to content

Commit

Permalink
Merge pull request #19 from PepeElToro41/dev
Browse files Browse the repository at this point in the history
fixed dead links
  • Loading branch information
PepeElToro41 authored Aug 6, 2024
2 parents 486b638 + 4f0a6c7 commit 9849477
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/docs/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This has the potential to cause an infinite loop.
<span class="type-declaration"><span class="type-namespace">Environment</span>
<span class="type-name">.</span><span class="type-function-name">CreateSnapshot</span>(<span class="type-name-opt">name</span>?<span class="type-name">:</span><span class="type-highlight">string</span>)</span>

Does the same as [Create Snapshot](/docs/features/snapshots.md#create-snapshot) button does. Useful for cloning the UI automatically.<br/>
Does the same as [Create Snapshot](/docs/plugin/extras.md#creating-snapshots) button does. Useful for cloning the UI automatically.<br/>
An additional `name` argument can be given for the created `ScreenGui`

<span class="tiphelp">Defaults an empty function in non-story environments</span>
Expand Down
26 changes: 9 additions & 17 deletions docs/docs/stories/advanced/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# Advanced Stories

Advanced Stories are table stories that get mounted internally by UI Labs. They allow UI Labs to have more control and info over how your stories are rendered.

Advanced Stories are table stories that get mounted internally by UI Labs. They allow UI Labs to have more control and info over how your stories are rendered.

These stories also allows you to add [Controls]("") to edit properties of your story in real-time.

These stories also allows you to add [Controls](/docs/controls/adding.md) to edit properties of your story in real-time.

::: details Flipbook support
In order to support [Flipbook Stories](https://flipbook-labs.github.io/flipbook/docs/story-format) and make migration easier, UI Labs uses a very similar format flipbook uses.
Expand All @@ -13,17 +11,14 @@ This has some key differences:

---

- The story library (`React` / `Roact` / `Fusion`) cant be provided in a storybook, only in the story itself. This limitation can be solved in the future.
- The story name cant be provided here, therefore, the module name will be always used.<br/>This is because UI Labs would need to perform a Hot-Reload operation on every story and update changes acordingly. This can be very expensive and unnecessary.
:::
- The story library (`React` / `Roact` / `Fusion`) cant be provided in a storybook, only in the story itself. This limitation can be solved in the future.
- The story name cant be provided here, therefore, the module name will be always used.<br/>This is because UI Labs would need to perform a Hot-Reload operation on every story and update changes acordingly. This can be very expensive and unnecessary.
:::

## Creating an Advanced Story



All advanced stories share a base format table structure.


<table>
<thead>
<tr>
Expand Down Expand Up @@ -59,8 +54,6 @@ All advanced stories share a base format table structure.
</tbody>
</table>



Let's see an example:

::: code-group
Expand Down Expand Up @@ -88,7 +81,7 @@ const story = {

export = story
```

:::

## Story Types
Expand All @@ -97,7 +90,6 @@ You will need to add additional keys depending on the story type you are using.

UI Labs currently supports 3 different types of advanced stories:

- [Roact / React Stories](./react.md)
- [Fusion Stories](./fusion.md)
- [Generic Stories](./generic.md) <span class="tiphelp">&nbsp; This story is generic and customizable, doesn't require a library</span>

- [Roact / React Stories](./react.md)
- [Fusion Stories](./fusion.md)
- [Generic Stories](./generic.md) <span class="tiphelp">&nbsp; This story is generic and customizable, doesn't require a library</span>

0 comments on commit 9849477

Please sign in to comment.