Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation in preparation for next release #276

Merged
merged 38 commits into from
Nov 16, 2024
Merged

Update documentation in preparation for next release #276

merged 38 commits into from
Nov 16, 2024

Conversation

vocksel
Copy link
Collaborator

@vocksel vocksel commented Nov 15, 2024

Problem

Our docs need an overhaul to reflect the upcoming release

Solution

This is a big PR so I'll try to break things down.

First of all here's what our new sidebar looks like:
Screenshot 2024-11-16 at 9 07 23 AM

And here's a summary of the changes:

  1. Introduced code-samples package to the root of the repo.
    1. This is a package containing various examples for use in our documentation. The kicker is these are run through analysis and linting just like any of our other Luau code, so our code samples in docs are easy to validate for correctness. It can also be synced to Studio and all of the included stories can be viewed in Flipbook
  2. Docs on writing stories have been rewritten
  3. Updated docs on our Story/Storybook formats to reflect changes from Storyteller
  4. Docs have been added for writing React, Fusion, and Roact stories along with tabs to switch to Storyteller variants
  5. Updated docs for contributors
  6. Minor change to our build script which now makes sure Flipbook's storybook does not leak through to prod builds

Checklist

  • Ran lune run test locally before merging

vocksel added a commit to flipbook-labs/storyteller that referenced this pull request Nov 16, 2024
# Problem

Trying to update flipbook's docs and part of that involves analyzing
code samples. But that's currently failing because Storyteller's Story
and Storybook types are too strict

flipbook-labs/flipbook#276

# Solution

Created new `LoadedStory` and`LoadedStorybook` types which have all the
implicitly defined properties that a user doesn't need to worry about.
`Story` and `Storybook` are now slimmed down
@vocksel vocksel marked this pull request as ready for review November 16, 2024 17:09
@vocksel vocksel merged commit cf981d6 into main Nov 16, 2024
5 checks passed
@vocksel vocksel deleted the docs branch November 16, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant