docs: show-updated-docs #5516

AmirSa12 · 2023-12-02T19:39:58Z

Overview

What is it?

Feature / enhancement
Bug
Docs / tests / types / typos

Description

This pull request introduces a valuable enhancement to Qwik's documentation website by implementing a "Recently Updated Docs" feature. This feature aims to improve user experience and keep users informed about the latest changes to the documentation.

Use cases and why

1. One use case
1. Another use case

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

showing the updated docs with a circle next to the title, in this commit I added the circles.

netlify · 2023-12-02T19:40:00Z

👷 Deploy request for qwik-insights pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`a229896`

gioboa · 2023-12-03T20:05:37Z

packages/docs/contributors.ts

@@ -88,7 +96,15 @@ async function updateGithubCommits(filePath: string) {

  console.log(repoPath, contributors.length);

-  await new Promise((resolve) => setTimeout(resolve, 1000));
+  if (response.headers.get('x-ratelimit-remaining') === '0') {


this condition is changing the current behaviour.
can you clarify why?

@mpeg can help us here as he implemented this.

hey, so the default behaviour is to wait 1s between calls to the github API, this change actually waits for however long the API rate limit header asks you to wait – it's really not great either way because the default rate limits are so low that without an API key you hit the hourly limit of calls and have to wait for a long time, but it's better than it failing outright which is the current behaviour

probably a good improvement for this (and the pnpm contributors script) would be to pass in an optional env variable with a GH api key so that it can run a lot faster if present

gioboa · 2023-12-03T20:09:46Z

packages/docs/src/components/sidebar/sidebar.tsx

              >
                {item.text}
+                {markdownItems[item.href!]?.frontmatter?.updated_at ? (
+                  new Date(markdownItems[item.href!]?.frontmatter?.updated_at!).getTime() +
+                    5 * 24 * 60 * 60 * 1000 >


Can you create a constant for this value?

I have made some changes, I think it's better now.

mhevery · 2023-12-06T00:45:33Z

Love the direction.

…xamples) (#5340)

* Update index.mdx Correct mistake. The original was: Both pages are created by adding ... Changed to: Pages are created by adding ... * trigger GH checks --------- Co-authored-by: gioboa <[email protected]>

Fix #5342

* fix(cli) parseTemplatePath doesn't work in windows * refactor use path.sep --------- Co-authored-by: Yale <[email protected]>

* fix(qwik): Incorrect module reference in inlinedQrl Fix #5368 * fixup! fix(qwik): Incorrect module reference in inlinedQrl

* docs: Alex Russell Approved Alex Russell Approved JavaScript framework * docs(faq): wording

fix(qwik-city): parseBody should not clone requests

…tch> (#5485) docs(module-prefetching): make the distinction between module-prefetching and <Link prefetch>

Update pages.json

… qwik nodes (#5497) Enable the prefixIds SVGO plugin by default, while still allowing customization. This is a follow up on #5407. Here's a discussion on why it makes sense when optimizing SVG files for the web: svg/svgo#674.

fix: polyfill only if needed

* Extend index.mdx to include QwikCityMockProvider * docs: add links between vitest integration page and qwikcity api page

* docs(glob-import): add documentation for import.meta.glob * docs(glob-imports): add Glob Import link to /cookbook/index.mdx * docs(glob-import): refactor type any to Record<string, any> * docs: add Record<string, any> to mdx as well

* fix: polyfill also when shimmed * chore: add comment to explain polyfill * chore: Giorgio's feedback

put the mardown update in a const which made the code cleaner and better to understand

mhevery · 2023-12-06T23:26:29Z

packages/docs/tsconfig.json

@@ -1,8 +1,8 @@
 {
  "compilerOptions": {
    "incremental": true,
-    "target": "ES2020",
-    "module": "ES2020",
+    "target": "ES2022",


Why are these changes needed?

mhevery · 2023-12-06T23:26:35Z

tsconfig.json

@@ -1,8 +1,8 @@
 {
  "compilerOptions": {
    "incremental": true,
-    "target": "ES2020",
-    "module": "ES2020",
+    "target": "ES2022",


Why ware these changes needed?

In the previous approach, I used a top level await which was required this to be 2022 or other options suggested.
but now since we are using a different approach, I reverted these to what they were. thanks!

mhevery · 2023-12-06T23:56:41Z

I have a fixed-up PR #5536 (for some reason, I can't push to this branch) Can you make this branch green based on the other one?

AmirSa12 · 2023-12-07T08:09:51Z

I have a fixed-up PR #5536 (for some reason, I can't push to this branch) Can you make this branch green based on the other one?

Yes!

AmirSa12 · 2023-12-07T19:37:18Z

I have a fixed-up PR #5536 (for some reason, I can't push to this branch) Can you make this branch green based on the other one?

Ready!

mpeg and others added 3 commits October 22, 2023 19:11

add created/updated date to docs frontmatter

735bfdb

read the frontmatter (#1)

4c2734c

feat: show updated docs

7e4229d

showing the updated docs with a circle next to the title, in this commit I added the circles.

AmirSa12 changed the title ~~Show recently updated docs on qwik's documentation website~~ feat: show-updated-docs Dec 2, 2023

gioboa reviewed Dec 3, 2023

View reviewed changes

zanettin added COMP: docs Improvements or additions to documentation WAITING FOR: user Further information is requested from the issue / pr opener labels Dec 3, 2023

gioboa and others added 20 commits December 6, 2023 22:21

chore(docs): remove warnings (#5345)

91e0e53

style(eslint): convey a stricter restriction from just to only (e…

f509432

…xamples) (#5340)

feat(vite): allow disabling dev SSR server in vite (#5347)

110d040

chore(docs): Small fix of file to edit (#5348)

68449c9

docs: Update index.mdx (#5351)

c1e7068

* Update index.mdx Correct mistake. The original was: Both pages are created by adding ... Changed to: Pages are created by adding ... * trigger GH checks --------- Co-authored-by: gioboa <[email protected]>

fix: action redirect accidentally stripped searchparams (#5349)

7882cf5

Fix #5342

fix: remove cf pages stream polyfill (#5352)

64d68ec

chore: updated twitter logo to X (#5357)

0a5356c

docs: update React cheat sheet title (#5358)

cd18a4b

1.2.15 (#5359)

1adb2aa

docs: improve SEO with descriptions (#5360)

4f2b968

fix(cli): parseTemplatePath doesn't work in windows (#5339)

2fbc880

* fix(cli) parseTemplatePath doesn't work in windows * refactor use path.sep --------- Co-authored-by: Yale <[email protected]>

docs: fix typo (#5361)

1ab768e

chore(qwik-insights): use clientOutDir if provided (#5366)

9c7b6c3

docs: remove soundy.cloud (#5374)

235766d

chore: clean up release script (#5376)

0256a0e

fix(qwik): Incorrect module reference in inlinedQrl (#5375)

2ec2c74

* fix(qwik): Incorrect module reference in inlinedQrl Fix #5368 * fixup! fix(qwik): Incorrect module reference in inlinedQrl

docs: Alex Russell Approved javascript framework (#5364)

174db33

* docs: Alex Russell Approved Alex Russell Approved JavaScript framework * docs(faq): wording

chore: improved README.md for build artifacts (#5377)

b33cd72

fix(qwik-city): parseBody should not clone Request (#5353)

ae3d2f3

fix(qwik-city): parseBody should not clone requests

maiieul and others added 15 commits December 6, 2023 22:30

docs: make the distinction between module-prefetching and <Link prefe…

a6b393f

…tch> (#5485) docs(module-prefetching): make the distinction between module-prefetching and <Link prefetch>

docs(showcase): add index.app and wiza.co (#5484)

896ae3b

Update pages.json

fix(docs): mdx interpreting title as component (#5499)

c7a6016

docs: cleanup the vdom section (#5500)

3dcd4d8

fix: revert "fix: remove cf pages stream polyfill" (#5502)

be3c6f3

fix: cf pages polyfill only if needed (#5507)

19edd3d

fix: polyfill only if needed

refactor: extract group type

5ff4c93

docs: add QwikCityMockProvider explanation (#5505)

866d856

* Extend index.mdx to include QwikCityMockProvider * docs: add links between vitest integration page and qwikcity api page

fix: CF pages polyfill also when shimmed (#5512)

db60b93

* fix: polyfill also when shimmed * chore: add comment to explain polyfill * chore: Giorgio's feedback

refactor: made the renderUpdate as a const

6fb38d1

put the mardown update in a const which made the code cleaner and better to understand

fix: fixed build

2bcc44b

fix: fixed conflicts

55ca3b5

docs: api update

0926502

mhevery mentioned this pull request Dec 6, 2023

docs: show-updated-docs #5536

Closed

7 tasks

mhevery changed the title ~~feat: show-updated-docs~~ docs: show-updated-docs Dec 6, 2023

mhevery reviewed Dec 6, 2023

View reviewed changes

AmirSa12 added 3 commits December 7, 2023 08:58

Merge remote-tracking branch 'upstream/main' into feat-docs-show-updated

525be8a

refactor: build

22cc81c

chore: fix pnpm-locke file

4487031

AmirSa12 added 4 commits December 7, 2023 20:06

chore: build

670a4e6

chore: pnpm fmt

aea5f8f

Merge remote-tracking branch 'upstream/main' into feat-docs-show-updated

f033f83

refactor: removed style-system

a229896

mhevery merged commit 7868054 into QwikDev:main Dec 7, 2023
22 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: show-updated-docs #5516

docs: show-updated-docs #5516

AmirSa12 commented Dec 2, 2023 •

edited

Loading

netlify bot commented Dec 2, 2023 •

edited

Loading

gioboa Dec 3, 2023

AmirSa12 Dec 4, 2023

mpeg Dec 4, 2023

gioboa Dec 3, 2023

AmirSa12 Dec 4, 2023 •

edited

Loading

mhevery commented Dec 6, 2023

mhevery Dec 6, 2023

mhevery Dec 6, 2023

AmirSa12 Dec 7, 2023 •

edited

Loading

mhevery commented Dec 6, 2023

AmirSa12 commented Dec 7, 2023

AmirSa12 commented Dec 7, 2023

docs: show-updated-docs #5516

docs: show-updated-docs #5516

Conversation

AmirSa12 commented Dec 2, 2023 • edited Loading

Overview

What is it?

Description

Use cases and why

Checklist:

netlify bot commented Dec 2, 2023 • edited Loading

👷 Deploy request for qwik-insights pending review.

gioboa Dec 3, 2023

Choose a reason for hiding this comment

AmirSa12 Dec 4, 2023

Choose a reason for hiding this comment

mpeg Dec 4, 2023

Choose a reason for hiding this comment

gioboa Dec 3, 2023

Choose a reason for hiding this comment

AmirSa12 Dec 4, 2023 • edited Loading

Choose a reason for hiding this comment

mhevery commented Dec 6, 2023

mhevery Dec 6, 2023

Choose a reason for hiding this comment

mhevery Dec 6, 2023

Choose a reason for hiding this comment

AmirSa12 Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

mhevery commented Dec 6, 2023

AmirSa12 commented Dec 7, 2023

AmirSa12 commented Dec 7, 2023

AmirSa12 commented Dec 2, 2023 •

edited

Loading

netlify bot commented Dec 2, 2023 •

edited

Loading

AmirSa12 Dec 4, 2023 •

edited

Loading

AmirSa12 Dec 7, 2023 •

edited

Loading