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

Document Layout Instability API #23007

Merged
merged 19 commits into from
Mar 15, 2023
Merged

Document Layout Instability API #23007

merged 19 commits into from
Mar 15, 2023

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Dec 16, 2022

Description

This PR aims to complete the reference docs for the https://wicg.github.io/layout-instability/ API. It also integrates it into the rest of the Performance API docs per our plan to have all Performance APIs in one group and at a central place.

Motivation

openwebdocs/project#62

Additional details

I was thinking about a checklist for what to do when documenting a new Performance API. I haven't come too far on that.

  • Update the main Performance_API page
  • Update the diagram
  • Mention the new API in the PerformanceEntry interface and update its sub pages.
  • Update GroupData to add new interfaces to the "Performance" group
  • Add new reference pages with the sidebar {{APIRef("Performance API")}}
  • Add a chapter to the guide (TBD)
  • Add new glossary pages for new metric name (if any)
  • Update self.performance page to talk about worker availability.

Related issues and pull requests

None.

@Elchi3 Elchi3 requested review from a team as code owners December 16, 2022 15:35
@Elchi3 Elchi3 requested review from wbamberg and bsmth and removed request for a team December 16, 2022 15:35
@github-actions github-actions bot added Content:Glossary Glossary entries Content:WebAPI Web API docs labels Dec 16, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Dec 16, 2022

@wbamberg
Copy link
Collaborator

I'll look at this one on Monday, Florian.

@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

files/en-us/glossary/cumulative_layout_shift/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/cumulative_layout_shift/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/layoutshift/hadrecentinput/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/layoutshift/hadrecentinput/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/layoutshiftattribution/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/layoutshiftattribution/node/index.md Outdated Show resolved Hide resolved
@github-actions github-actions bot removed the Content:Glossary Glossary entries label Feb 17, 2023
@Elchi3 Elchi3 requested a review from wbamberg February 17, 2023 14:51
@Elchi3
Copy link
Member Author

Elchi3 commented Feb 17, 2023

Sorry for being so slow to get back into this. I removed CLS for now and presented it more like a metric that people derive with the help of this API but it might not be the only one. The examples also no longer attempt to do (outdated) CLS calculations.

@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions
Copy link
Contributor

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions github-actions bot added Content:Media Media docs and removed rebase needed 🚧 labels Feb 28, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 1, 2023

This pull request has merge conflicts that must be resolved before it can be merged.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 2, 2023

This pull request has merge conflicts that must be resolved before it can be merged.

@Elchi3
Copy link
Member Author

Elchi3 commented Mar 2, 2023

This is ready for a re-review, fwiw. I keep getting merge conflicts 😅

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

Thanks Florian!

files/en-us/web/api/layoutshift/lastinputtime/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/layoutshiftattribution/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/layoutshift/hadrecentinput/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

Thanks Florian!

@Elchi3 Elchi3 requested a review from wbamberg March 14, 2023 13:16
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

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

👍 thank you @Elchi3 !

@wbamberg wbamberg merged commit ee43a00 into mdn:main Mar 15, 2023
@Elchi3 Elchi3 deleted the layout-instability branch March 15, 2023 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants