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.

Sign up for GitHub

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

Jump to bottom

docs: improvements #240

Merged
merged 18 commits into from
Mar 27, 2024
Merged

docs: improvements #240

merged 18 commits into from
Mar 27, 2024

Conversation

stephancill
Copy link
Contributor

@stephancill stephancill commented Mar 25, 2024 •
edited
Loading

Change Summary

  • adds default context reference to createFrames reference
  • frames.js for apps section
  • clean up example filenames, add steps
  • createFrames params
  • troubleshooting docs
  • update useFrame reference
  • make button docs more visible
  • multi-page guide

Merge Checklist

  • PR has a Changeset
  • PR includes documentation if necessary
  • PR updates the boilerplates if necessary

@vercel Vercel
Copy link

vercel bot commented Mar 25, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
frames-js ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 27, 2024 1:52pm
framesjs-debugger ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 27, 2024 1:52pm

@stephancill stephancill changed the base branch from main to dev March 25, 2024 15:37
@stephancill stephancill force-pushed the docs/docs-improvements branch from 609599f to 2e2dd4b Compare March 25, 2024 15:54
davidfurlong
davidfurlong approved these changes Mar 25, 2024
View reviewed changes
docs/pages/reference/core/createFrames.mdx

Type: `FramesMiddleware`

An array of middleware functions that are called before the frame handler and allows you to inject additional context into the `ctx` parameter passed to each frame handler call.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps this should link to the middleware docs

@stephancill stephancill force-pushed the docs/docs-improvements branch from 2981297 to 46f0041 Compare March 26, 2024 14:02
@stephancill stephancill mentioned this pull request Mar 26, 2024
Closed
@stephancill stephancill force-pushed the docs/docs-improvements branch from f16e742 to 77a3cc2 Compare March 27, 2024 08:53
@stephancill stephancill force-pushed the docs/docs-improvements branch from 77a3cc2 to 6bffb09 Compare March 27, 2024 09:30
@stephancill stephancill force-pushed the docs/docs-improvements branch from a843c55 to 45c1c99 Compare March 27, 2024 12:03
stephancill and others added 2 commits March 27, 2024 15:39
@stephancill @michalkvasnicak
Update docs/pages/troubleshooting.mdx
ceadc1f 
Co-authored-by: Michal Kvasničák <michal.kvasnicak@gmail.com>
@stephancill @michalkvasnicak
Update docs/pages/troubleshooting.mdx
26de29b 
Co-authored-by: Michal Kvasničák <michal.kvasnicak@gmail.com>
stephancill and others added 2 commits March 27, 2024 15:51
@stephancill @michalkvasnicak
Update docs/pages/reference/core/createFrames.mdx
e2d5c17 
Co-authored-by: Michal Kvasničák <michal.kvasnicak@gmail.com>
@stephancill @michalkvasnicak
Update docs/pages/reference/core/createFrames.mdx
fdc917a 
Co-authored-by: Michal Kvasničák <michal.kvasnicak@gmail.com>
@stephancill stephancill merged commit 5f9fcfb into dev Mar 27, 2024
7 checks passed
@stephancill stephancill deleted the docs/docs-improvements branch March 27, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@michalkvasnicak michalkvasnicak michalkvasnicak left review comments

@davidfurlong davidfurlong Awaiting requested review from davidfurlong

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stephancill @michalkvasnicak @davidfurlong