Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add non-normative explanations for each of the attributes and when they are set or unset #157

Closed
Tracked by #38
npm1 opened this issue Sep 22, 2021 · 3 comments · Fixed by #159
Closed
Tracked by #38

Comments

@npm1
Copy link
Contributor

npm1 commented Sep 22, 2021

Now that there is better integration with Fetch and HTML, it seems harder to understand what is going on by just looking at the Navigation Timing spec. Perhaps we should add some explanations either in the spec itself or in a separate explainer file where it is clear what the attributes are, when they should be set, etc.

It may also be beneficial to link the callers of the main methods, like the one to create a navigation timing entry. In particular, the HTML spec is hard to search (and that's assuming you know it is called from that spec, and not others like DOM or Fetch). The problem with this is that it may be harder to keep up to date.

@yoavweiss
Copy link
Contributor

/cc @noamr

@noamr
Copy link
Contributor

noamr commented Sep 23, 2021

I'm wondering if non-normative explanations is the way to go here, or we should find a mechanism where w3c specs can automatically find references in whatwg specs. Otherwise those links and explanations can become stale. Maybe a combination of both? Not sure if trying to link w3c/whatwg like this is a can of worms, or if we were planning to move some of these specs to whatg (?)

@yoavweiss
Copy link
Contributor

Linking across orgs seems fine, but I agree about staleness concerns.

/cc @marcoscaceres who may have ideas on relevant tooling that can help.

noamr added a commit that referenced this issue Sep 27, 2021
Each attribute has a "note" explanation of when it is measured, with a
link to the service-worker/HTML spec where it's being measured in
practice.

Also update the diagram to include service-worker handling.

Closes #157.
noamr added a commit that referenced this issue Sep 27, 2021
Each attribute has a "note" explanation of when it is measured, with a
link to the service-worker/HTML spec where it's being measured in
practice.

Also update the diagram to include service-worker handling.

Closes #157.
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants