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

docs: qwik install and troubleshooting instructions #20939

Merged
merged 1 commit into from
Feb 8, 2023

Conversation

literalpie
Copy link
Contributor

@literalpie literalpie commented Feb 5, 2023

What I did

Add some setup docs for Qwik that were not included when I created the framework.

How to test

I tested this by launching the front-page project, with a copy of the docs folder with these changes (the yarn link workspace command didn't work for me).
I confirmed that the added docs do show up in the docs site:
image

Checklist

  • [N/A] Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • [N/A] If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • If this PR should be tested against many or all sandboxes,
    make sure to add the ci:merged or ci:daily GH label to it.
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "documentation", "maintenance", "dependencies", "other"]

Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@literalpie, thanks for taking the time and effort into this pull request and adding the initial set of documentation for the QWIK framework. Appreciate it 🙏 !

Regarding this item:

I tested this by launching the front-page project, with a copy of the docs folder with these changes (the yarn link workspace command didn't work for me).

That's something we want to revisit at some point as it may be cumbersome for not only you or any other contributor to set up the documentation and preview it locally. If you're ok with adding an issue in the Storybook frontpage repository and mentioning what you've experienced, we'd appreciate it. So that we can look into it and fix it so that you or anyone else doesn't need to manually copy over the documentation folder.

With that out of the way, it's all good on my end, and I'll merge this in a bit, as soon as the checklist clears.

Hope you have a great day.

Stay safe

@jonniebigodes jonniebigodes merged commit 34b4920 into storybookjs:next Feb 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants