qwik icon indicating copy to clipboard operation
qwik copied to clipboard

docs: fix typo diagramm

Open forresst opened this issue 3 years ago • 1 comments

What is it?

  • [ ] Feature / enhancement
  • [ ] Bug
  • [X] Docs / tests

Description

The life cycle diagram contains errors.

Before:

image

After:

image

I decided to redraw the diagram with Excalidraw trying to respect the original SVG.

There are several advantages to this:

  • The file size is smaller (271 ko -> 53 ko)
  • the SVG contains the Excalidraw scene, so it will be easier to modify it by opening this file in Excalidraw.
  • it also makes it easier to translate the diagram into another language. Here is the example in French using Excalidraw:

image

Use cases and why

Nope

Checklist:

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

forresst avatar Oct 28 '22 11:10 forresst

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Hi @forresst Thanks a lot for updating this file 🙏 Just wanted to check where the file is actually used and it looks like it is imported but never displayed atm 🙈 (or i am just blind.. 👀 😆 ) docs page: https://qwik.builder.io/docs/components/lifecycle/ docs file: https://github.com/BuilderIO/qwik/blob/main/packages/docs/src/routes/docs/components/lifecycle/index.mdx

zanettin avatar Jan 15 '23 20:01 zanettin

yeah this was changed @zanettin you are correct, thanks for checking!

Thanks so much for this @forresst ! sorry this hasn't got merged, we appreciate your work on this!

shairez avatar Jan 16 '23 00:01 shairez

OK if it is not visible, it is not interesting.

forresst avatar Jan 16 '23 12:01 forresst