Skip to content

Commit

Permalink
Update introductory content (#190)
Browse files Browse the repository at this point in the history
# Problem

Our introductory content in the README and in our Moonwave docs is
lacking and could use some sprucing out

# Solution

Took a pass over the README and our intro, and also made time to get to
#172

Closes #172 

# Checklist

- [ ] Ran `./bin/test.sh` locally before merging
  • Loading branch information
vocksel authored Feb 15, 2023
1 parent 5561e89 commit 6d8d6bd
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 17 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# flipbook
# <img src="img/flipbook.png" alt="Plugin icon" height="32" /> flipbook

[![Install](https://img.shields.io/badge/install-Roblox%20Marketplace-informational)](https://www.roblox.com/library/8517129161)
[![Docs](https://img.shields.io/badge/learn-Documentation-brightgreen)](https://vocksel.github.io/flipbook)
[![CI](https://github.com/vocksel/flipbook/actions/workflows/ci.yml/badge.svg)](https://github.com/vocksel/flipbook/actions/workflows/ci.yml)
[![Docs](https://img.shields.io/badge/docs-website-brightgreen)](https://vocksel.github.io/flipbook)

With flipbook you can quickly iterate on Roact components in an isolated, sandboxed environment to streamline the process of creating reusable UI components.

flipbook is a storybook plugin that previews UI components in a sandboxed environment. With it you can isolate distinct parts of your game's UI to hammer out edge cases and complex states without having to run through the whole UI.

With native support for popular UI libraries like [Roact](https://github.com/roblox/roact), [Fusion](https://github.com/Elttob/Fusion), and [Roact 17](https://github.com/grilme99/CorePackages#roact17), no matter how you create UI you can write a story for it in flipbook

![Screenshot of flipbook showing off the ButtonWithControls story](.moonwave/static/main-screenshot.png)

## Download
## Installation

You can install the latest version of flipbook from the [Roblox marketplace](https://www.roblox.com/library/8517129161).
You can install flipbook from the [Roblox marketplace](https://www.roblox.com/library/8517129161) or from the [GitHub releases](https://github.com/vocksel/flipbook/releases) page.

## Documentation

Learn how to use flipbook [here](https://vocksel.github.io/flipbook).
Learn how to use flipbook on the [documentation site](https://vocksel.github.io/flipbook).

## Contributing

Interested in contributing? Check out our [contributing guide](https://vocksel.github.io/flipbook/docs/contributing).
Before opening a pull request, check out our [contributing guide](https://vocksel.github.io/flipbook/docs/contributing) to learn how we develop the plugin.

## License

Expand Down
11 changes: 6 additions & 5 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@ sidebar_position: 1

# Getting Started

flipbook is a Roblox plugin for previewing Roact components in real-time to speed up development and help you break down your components into small, reusable parts of your app.
flipbook is a storybook plugin that previews UI components in a sandboxed environment. With it you can isolate distinct parts of your game's UI to hammer out edge cases and complex states without having to run through the whole UI.

![Screenshot of flipbook showing off the ButtonWithControls story](/main-screenshot.png)
With native support for popular UI libraries like [Roact](https://github.com/roblox/roact), [Fusion](https://github.com/Elttob/Fusion), and [Roact 17](https://github.com/grilme99/CorePackages#roact17), no matter how you create UI you can write a story for it in flipbook

## Download
![Screenshot of flipbook showing off the ButtonWithControls story](/main-screenshot.png)

To install flipbook, head on over to the [Roblox marketplace](https://www.roblox.com/library/8517129161) and click "Install" to get the latest version.
## Installation

To install flipbook, visit the [Roblox marketplace](https://www.roblox.com/library/8517129161) and click "Install" to get the latest version.

## Writing Stories

With flipbook installed, it's time to create your first storybook and accompanying story files. Head over to [Writing Stories](writing-stories.md) to learn more.
Learn how to create a storybook and stories on the [Writing Stories](writing-stories.md) page.
6 changes: 5 additions & 1 deletion docs/story-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ return {

## Functional Story

A Functional story uses a function to create and mount its UI. This is the most flexible story format and is useful when using a UI library that is not yet natively supported by flipbook. You simply parent your UI elements to the supplied `target` instance. You can optionally return a function that gets called to cleanup the story.
A Functional story uses a function to create and mount UI. This is the most flexible story format and is useful when using a UI library that is not yet natively supported by flipbook. You simply parent your UI elements to the `target` argument and optionally return a function that gets called to cleanup the story.

| Name | Type | Description |
| -------- | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -189,6 +189,10 @@ return {
padding.Parent = label

label.Parent = parent

return function()
label:Destroy()
end
end,
}
```
Expand Down
8 changes: 4 additions & 4 deletions moonwave.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[docusaurus]
tagline = "Storybook plugin for Roact development"
tagline = "A storybook plugin for Roblox"

[home]
enabled = true

[[home.features]]
title = "Build UI faster"
description = "With flipbook you can quickly iterate on Roact components in an isolated, sandboxed environment to streamline the process of creating reusable UI components."
title = "Isolate your UI"
description = "With flipbook you can isolate distinct parts of your game's UI to hammer out edge cases and complex states without having to run through the whole UI"
# image=""

[[home.features]]
Expand All @@ -17,4 +17,4 @@ description = "Set custom controls that your stories can respond to while iterat
[[home.features]]
title ="Support for Hoarcekat"
description = "Bring your existing stories from Hoarcekat over to flipbook by adding a Storybook to set them up."
# image=""
# image=""

0 comments on commit 6d8d6bd

Please sign in to comment.