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: fix docs #292

Merged
merged 4 commits into from
Aug 14, 2024
Merged

docs: fix docs #292

merged 4 commits into from
Aug 14, 2024

Conversation

nobkd
Copy link
Collaborator

@nobkd nobkd commented Aug 5, 2024

These are mostly typo / grammar / link fixes, as well as markdown formatting.
I also added some TODOs for links, which are not contained in the docs (e.g. todomvc example)

I think this can be merged after

are done, as they are each smaller in scope, also because they're only one file each.

Some of my changes will probably already be fixed then, so I will always rebase, when any of them are merged.

background-color: #0005;
backdrop-filter: blur(4px);
transition: .5s;
}

/* styles when the popover is about to be displayed */
@starting-style {
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Changed, because order matters.

Note

The @starting-style at-rule and the "original rule" have the same specificity. To ensure that starting styles get applied, include the @starting-style at-rule after the "original rule". If you specify the @starting-style at-rule before the "original rule", the original styles will override the starting styles.

From: https://developer.mozilla.org/en-US/docs/Web/CSS/@starting-style

@nobkd nobkd mentioned this pull request Aug 5, 2024
@@ -93,7 +92,7 @@ The two metrics that measure page rendering speed are [first contentful paint](/



Please compare [Tailwind metrics](//pagespeed.web.dev/analysis/https-spotlight-tailwindui-com/cqtnf4xxoy?form_factor=mobile) with [Semantic CSS metcis ](//pagespeed.web.dev/analysis/https-nuejs-org-spotlight/6nnhwwnz8b?form_factor=mobile).
Please compare [Tailwind metrics](//pagespeed.web.dev/analysis/https-spotlight-tailwindui-com/cqtnf4xxoy?form_factor=mobile) with [Semantic CSS metrics](//pagespeed.web.dev/analysis/https-nuejs-org-spotlight/6nnhwwnz8b?form_factor=mobile).
Copy link
Collaborator Author

@nobkd nobkd Aug 5, 2024

Choose a reason for hiding this comment

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

These links do not work anymore, and the page-speeds are negligibly different:
Nue: https://pagespeed.web.dev/analysis/https-nuejs-org-spotlight/i0itoo400b?form_factor=mobile
Tailwind: https://pagespeed.web.dev/analysis/https-spotlight-tailwindui-com/98p017y0jm?form_factor=mobile

Previous comment: 89aaa51#r144877042


The previous links were broken, probably, because the links are thrown away after some time.
The results can probably be saved with e.g. a local lighthouse installation (via bun / npm), and then the result file can get served.
AFAIK this generates a single html file, so it shouldn't be to hard.

@@ -219,9 +219,9 @@ Options given as YAML:

`poster` a URL for an image to be shown before the playback starts

`preload` a [hint to the browser][preload] on what to load prior playback
`preload` <span>a [hint to the browser][preload] on what to load prior playback</span>
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Would break because of flex on .options otherwise, as a new element is inserted, and flex breaks the text wrapping (most noticeable on small screens) and removes spaces.

Currently, for whatever reason, strips the underline from the link when wrapped in a span... 🤷

Previous comments:

Copy link
Collaborator Author

@nobkd nobkd Aug 6, 2024

Choose a reason for hiding this comment

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

Without span:

image

  • breaks the text flow

With span:

image

  • missing underline on link

@nobkd nobkd force-pushed the fix-docs branch 2 times, most recently from 978506b to 8d0c76b Compare August 5, 2024 22:12
@nobkd nobkd marked this pull request as draft August 6, 2024 02:19
@nobkd nobkd force-pushed the fix-docs branch 6 times, most recently from a91164b to 7fb840e Compare August 9, 2024 22:57
@nobkd nobkd force-pushed the fix-docs branch 6 times, most recently from 3fd2e7a to fac195b Compare August 13, 2024 14:39
@nobkd nobkd marked this pull request as ready for review August 13, 2024 15:25
@tipiirai
Copy link
Contributor

This was HUGE! Thank you!

@tipiirai tipiirai merged commit 50df540 into dev Aug 14, 2024
@tipiirai tipiirai deleted the fix-docs branch August 14, 2024 03:00
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.

2 participants