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

refactor(package.json): add docs.dev & docs.preview #5396

Merged
merged 1 commit into from
Nov 3, 2023

Conversation

maiieul
Copy link
Collaborator

@maiieul maiieul commented Nov 3, 2023

Overview

What is it?

  • Feature / enhancement
  • Bug
  • Docs / tests / types / typos

Description

Add package.json docs.dev & docs.preview scripts to improve the DX for contributors. Having to cd manually in packages/docs had me writing root commands in the wrong folder. This can be a bit frustrating and I think dev and preview commands are common enough that this should slightly improve the DX for contributors.

For those that are used to the workflow, cd packages/docs && pnpm start will keep working.

Checklist:

  • My code follows the developer guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • Added new tests to cover the fix / functionality

Add pnpm docs.dev & pnpm docs.preview commands to improve the DX for contributors.
Copy link

netlify bot commented Nov 3, 2023

‼️ Deploy request for qwik-insights rejected.

Name Link
🔨 Latest commit 13d9e8b

Copy link
Member

@wmertens wmertens left a comment

Choose a reason for hiding this comment

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

LGTM

@wmertens wmertens merged commit a1f978b into QwikDev:main Nov 3, 2023
21 checks passed
kodiakhq bot pushed a commit to ascorbic/unpic-img that referenced this pull request Nov 5, 2023
[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@builder.io/qwik](https://qwik.builder.io/) ([source](https://togithub.com/BuilderIO/qwik)) | [`1.2.15` -> `1.2.17`](https://renovatebot.com/diffs/npm/@builder.io%2fqwik/1.2.15/1.2.17) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@builder.io%2fqwik/1.2.17?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@builder.io%2fqwik/1.2.17?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@builder.io%2fqwik/1.2.15/1.2.17?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@builder.io%2fqwik/1.2.15/1.2.17?slim=true)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>BuilderIO/qwik (@&#8203;builder.io/qwik)</summary>

### [`v1.2.17`](https://togithub.com/BuilderIO/qwik/releases/tag/v1.2.17)

[Compare Source](https://togithub.com/BuilderIO/qwik/compare/v1.2.16...v1.2.17)

##### What's Changed

-   fix(labs): Better handling and visibility of q-insights.json by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5384
-   feat(insights): Add new route visibility by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5385
-   fix(vite): resolution of nested dependencies by [@&#8203;wmertens](https://togithub.com/wmertens) in [QwikDev/qwik#5383
-   docs: fix incorrect escaping in URL by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5387
-   fix(insights): improve files per cluster by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5388
-   fix(qwik): Improve logging of vite plugin by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5389
-   fix(core): parent component lookup during pause by [@&#8203;wmertens](https://togithub.com/wmertens) in [QwikDev/qwik#5390
-   chore: clean up docs site build warnings by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5391
-   docs: explain custom event props and detail when PropFunction is needed by [@&#8203;maiieul](https://togithub.com/maiieul) in [QwikDev/qwik#5386
-   docs: don't index demos; don't duplicate meta descriptions by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5392
-   docs: add custom 404 page by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5393
-   chore(docs): small improvements to routing/index.mdx by [@&#8203;wmertens](https://togithub.com/wmertens) in [QwikDev/qwik#5395
-   refactor(package.json): add docs.dev & docs.preview by [@&#8203;maiieul](https://togithub.com/maiieul) in [QwikDev/qwik#5396
-   chore: 1.2.17 by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5397

**Full Changelog**: QwikDev/qwik@v1.2.16...v1.2.17

### [`v1.2.16`](https://togithub.com/BuilderIO/qwik/releases/tag/v1.2.16)

[Compare Source](https://togithub.com/BuilderIO/qwik/compare/v1.2.15...v1.2.16)

##### What's Changed

-   docs: improve SEO with descriptions by [@&#8203;hamatoyogi](https://togithub.com/hamatoyogi) in [QwikDev/qwik#5360
-   fix(cli): parseTemplatePath doesn't work in windows by [@&#8203;yuyidegit](https://togithub.com/yuyidegit) in [QwikDev/qwik#5339
-   docs: fix typo by [@&#8203;mBonny87](https://togithub.com/mBonny87) in [QwikDev/qwik#5361
-   chore(qwik-insights): use clientOutDir if provided by [@&#8203;intellix](https://togithub.com/intellix) in [QwikDev/qwik#5366
-   docs: remove soundy.cloud by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5374
-   chore: clean up release script by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5376
-   fix(qwik): Incorrect module reference in inlinedQrl by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5375
-   docs: Alex Russell Approved javascript framework by [@&#8203;PatrickJS](https://togithub.com/PatrickJS) in [QwikDev/qwik#5364
-   chore: improved README.md for build artifacts by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5377
-   fix(qwik-city): parseBody should not clone Request by [@&#8203;mpeg](https://togithub.com/mpeg) in [QwikDev/qwik#5353
-   docs(eslint-rules): refactor use-method-usage to reflect current qwik… by [@&#8203;maiieul](https://togithub.com/maiieul) in [QwikDev/qwik#5344
-   fix: Yarn 3/4 PnP compatibility by [@&#8203;ianlet](https://togithub.com/ianlet) in [QwikDev/qwik#5042
-   revert: refactor(optimizer): remove using resolvePackageData API from Vite by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5379
-   docs: update Alex Russell by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5381
-   chore: 1.2.16 by [@&#8203;mhevery](https://togithub.com/mhevery) in [QwikDev/qwik#5382

##### New Contributors

-   [@&#8203;yuyidegit](https://togithub.com/yuyidegit) made their first contribution in [QwikDev/qwik#5339
-   [@&#8203;mBonny87](https://togithub.com/mBonny87) made their first contribution in [QwikDev/qwik#5361
-   [@&#8203;ianlet](https://togithub.com/ianlet) made their first contribution in [QwikDev/qwik#5042

**Full Changelog**: QwikDev/qwik@v1.2.15...v1.2.16

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "after 9pm on sunday" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ascorbic/unpic-img).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMS41IiwidXBkYXRlZEluVmVyIjoiMzcuMzEuNSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
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.

None yet

2 participants